Skip to content

Latest commit

 

History

History
55 lines (36 loc) · 1.14 KB

CONTRIBUTING.md

File metadata and controls

55 lines (36 loc) · 1.14 KB

Contributing

Contributions are actively welcome!

Local Setup

Create a virtualenv for local development using your tool of choice. If you're using pyenv and pyenv-virtualenv:

pyenv virtualenv 3.8.5 flask-resty
pyenv local flask-resty

Install dependencies:

# optionally include [jwt] for the full test suite, but requires cryptography,
#  and its dependent binary libraries
pip install -e .[dev]

# Or for zsh users
pip install -e .\[dev\]

Running tests

Tests can be run for your current enviroment by running pytest directly:

pytest

To run formatting and syntax checks:

tox -e lint

To run tests in all supported Python versions in their own virtual environments (must have each interpreter installed):

tox

Documentation

Contributions to the documentation are welcome. Documentation is written in reStructuredText (rST). A quick rST reference can be found here. Builds are powered by Sphinx.

To build the docs in "watch" mode:

tox -e watch-docs

Changes in the docs/ directory will automatically trigger a rebuild.