1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45
|
.. _development_and_contributing:
Development and contributing
============================
To do development work for Simple JWT, make your own fork on Github, clone it
locally, make and activate a virtualenv for it, then from within the project
directory:
.. code-block:: bash
pip install --upgrade pip setuptools
pip install -e .[dev]
If you're running a Mac and/or with zsh, you need to escape the brackets:
.. code-block:: bash
pip install -e .\[dev\]
To run the tests:
.. code-block:: bash
pytest
To run the tests in all supported environments with tox, first `install pyenv
<https://github.com/pyenv/pyenv#installation>`__. Next, install the relevant
Python minor versions and create a ``.python-version`` file in the project
directory:
.. code-block:: bash
pyenv install 3.9.x
cat > .python-version <<EOF
3.9.x
EOF
Above, the ``x`` in each case should be replaced with the latest corresponding
patch version. The ``.python-version`` file will tell pyenv and tox that
you're testing against multiple versions of Python. Next, run tox:
.. code-block:: bash
tox
|