Contributions are welcome, and they are greatly appreciated! Every little bit helps, and credit will always be given.
When 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.
The Open API Specifications Advanced Python Introspection library could always use more documentation, whether as part of the official The Open API Specifications Advanced Python Introspection library docs, in docstrings, or even on the web in blog posts, articles, and such.
Feature requests and feedback¶
The best way to send feedback is to file an issue at https://github.com/sdementen/oasapi/issues.
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 code contributions are welcome :)
To set up oasapi for local development:
Fork oasapi (look for the “Fork” button).
Clone your fork locally:
git clone firstname.lastname@example.org:sdementen/oasapi.git
Create a branch for local development:
git checkout -b name-of-your-bugfix-or-feature
Now you can make your changes locally.
When you’re done making changes run all the checks and docs builder with tox one command:
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
Submit a pull request through the GitHub website.
Pull Request Guidelines¶
If you need some code review or feedback while you’re developing the code just make the pull request.
For merging, you should:
- Include passing tests (run
- Update documentation when there’s new API, functionality etc.
- Add a note to
CHANGELOG.rstabout the changes.
- Add yourself to
If you don’t have all the necessary python versions available locally you can rely on Travis - it will run the tests for each change you add in the pull request.
It will be slower though …
To install a minimal virtual environment with tox (see https://docs.python.org/3/tutorial/venv.html#creating-virtual-environments )
cd path-to-your-oasapi-folder python -m venv .env ' activate your .env virtualenv python -m pip install -r requirements-dev.txt
To install the git pre-commit scripts:
To run the tests locally:
cd path-to-your-oasapi-folder ' activate your .env virtualenv tox
To build the documentation locally (available in the folder
docs/dist, entry point
cd path-to-your-oasapi-folder ' activate your .env virtualenv tox -e docs
To recreate the tox environments (e.g. if you add a dependency in the setup.py):
tox --recreate tox --recreate -e py36 '(only the py36 environment)
To run a subset of tests:
tox -e envname -- pytest -k test_myfeature
To run all the test environments in parallel (you need to
pip install detox):
Tips with PyCharm¶
To run tox within PyCharm, right click on
tox.ini and choose
Run (see https://www.jetbrains.com/help/pycharm/tox-support.html)
Tips to deploy (for the maintainers)¶
To bump the version:
' update/commit first all your changes including the changelog bump2version patch --tag --commit
To build the source distribution:
' clean first the /dist folder python setup.py sdist
To upload on PyPI Test:
python -m twine upload --repository-url https://test.pypi.org/legacy/ dist/*
To upload on PyPI:
python -m twine upload dist/*
For the setup of the deploy to PyPI step on Travis, the information on https://docs.travis-ci.com/user/deployment/pypi/ (with the online encrypt tool on https://travis-encrypt.github.io/) were useful.