From ee74f3c0919d679351009a241481bdeb0fb73fe5 Mon Sep 17 00:00:00 2001 From: Travis Hathaway Date: Thu, 8 Feb 2018 15:52:29 -0800 Subject: [PATCH] Additions to make the project more OSS friendly These additions make this project more OSS friendly and help increase the usuability from a developer's point of view. --- .gitignore | 7 +++- CONTRIBUTING.md | 108 ++++++++++++++++++++++++++++++++++++++++++++++++ HISTORY.md | 7 ++++ setup.cfg | 2 + setup.py | 49 ++++++++++++++++++++++ 5 files changed, 172 insertions(+), 1 deletion(-) create mode 100644 CONTRIBUTING.md create mode 100644 HISTORY.md create mode 100644 setup.cfg create mode 100644 setup.py diff --git a/.gitignore b/.gitignore index 7707821..e4faa31 100644 --- a/.gitignore +++ b/.gitignore @@ -37,4 +37,9 @@ nosetests.xml # Other .DS_Store -doc/_build \ No newline at end of file +doc/_build + +*.swp +*.swo + +.idea diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..24730ea --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,108 @@ +Contributing +============ + +Contributions are welcome, and they are greatly appreciated! Every +little bit helps, and credit will always be given. + +You can contribute in many ways: + +Types of Contributions +---------------------- + +### Report Bugs + +Report bugs at . + +If you are reporting a bug, please include: + +- Your operating system name and version. +- Any details about your local setup that might be helpful in + troubleshooting. +- Detailed steps to reproduce the bug. + +### Fix Bugs + +Look through the GitHub issues for bugs. Anything tagged with \"bug\" +and \"help wanted\" is open to whoever wants to implement it. + +### Implement Features + +Look through the GitHub issues for features. Anything tagged with +\"enhancement\" and \"help wanted\" is open to whoever wants to +implement it. + +### Write Documentation + +UMAMI CLI could always use more documentation, whether as part of the +official UMAMI CLI docs, in docstrings, or even on the web in blog +posts, articles, and such. + +### Submit Feedback + +The best way to send feedback is to file an issue at +. + +If you are proposing a feature: + +- Explain in detail how it would work. +- Keep the scope as narrow as possible, to make it easier to + implement. +- Remember that this is a volunteer-driven project, and that + contributions are welcome :) + +Get Started! +------------ + +Ready to contribute? Here\'s how to set up EmmaPython for local +development. + +1. Fork the EmmaPython repo on GitHub. +2. Clone your fork locally: + + $ git clone git@github.com:your_name_here/EmmaPython.git + +3. Install your local copy into a virtualenv. Assuming you have + virtualenvwrapper installed, this is how you set up your fork for + local development: + + $ mkvirtualenv EmmaPython + $ cd EmmaPython/ + $ python setup.py develop + +4. Create a branch for local development: + + $ git checkout -b name-of-your-bugfix-or-feature + + Now you can make your changes locally. + +5. When you\'re done making changes, check that your changes pass + flake8 and the tests, including testing other Python versions with + tox: + + $ flake8 EmmaPython tests + $ python setup.py test or py.test + $ tox + + To get flake8 and tox, just pip install them into your virtualenv. + +6. Commit your changes and push your branch to GitHub: + + $ git add . + $ git commit -m "Your detailed description of your changes." + $ git push origin name-of-your-bugfix-or-feature + +7. Submit a pull request through the GitHub website. + +Pull Request Guidelines +----------------------- + +Before you submit a pull request, check that it meets these guidelines: + +1. The pull request should include tests. +2. If the pull request adds functionality, the docs should be updated. + Put your new functionality into a function with a docstring, and add + the feature to the list in README.rst. +3. The pull request should work for Python 2.6, 2.7, 3.3, 3.4 and 3.5, + and for PyPy. Check + and make + sure that the tests pass for all supported Python versions. diff --git a/HISTORY.md b/HISTORY.md new file mode 100644 index 0000000..f798355 --- /dev/null +++ b/HISTORY.md @@ -0,0 +1,7 @@ +History +======= + +1.0.0 (2018-02-08) +------------------ + +- First release on PyPI. diff --git a/setup.cfg b/setup.cfg new file mode 100644 index 0000000..b88034e --- /dev/null +++ b/setup.cfg @@ -0,0 +1,2 @@ +[metadata] +description-file = README.md diff --git a/setup.py b/setup.py new file mode 100644 index 0000000..475693d --- /dev/null +++ b/setup.py @@ -0,0 +1,49 @@ +#!/usr/bin/env python +# -*- coding: utf-8 -*- + +"""The setup script.""" + +from setuptools import setup, find_packages + +try: + import pypandoc + readme = pypandoc.convert('README.md', 'rst') +except (IOError, ImportError): + readme = '' + +requirements = [ + 'requests==1.1.0', +] + +test_requirements = [ + 'nose', +] + +setup( + name='emma-python', + version='1.0.0', + description="Python library for working with Emma API", + long_description=readme, + author="Doug Hurst", + author_email='support@myemma.com', + url='https://github.com/myemma/EmmaPython', + packages=find_packages(include=[ + 'emma', + 'emma.adapter', + 'emma.model', + 'emma.query' + ]), + include_package_data=True, + install_requires=requirements, + zip_safe=False, + keywords='emma', + classifiers=[ + 'Intended Audience :: Developers', + 'Natural Language :: English', + 'Programming Language :: Python :: 2.7', + 'License :: OSI Approved :: MIT License', + ], + test_suite='tests', + tests_require=test_requirements, + license='MIT' +)