This package uses Tox to run tests on multiple versions of Python.
To set up your development environment, you'll need to install a few things. For Python version management, we use pyenv-virtualenv. Follow the installation instructions there, and then in the root directory of this repo run:
# Install all the Python versions this package supports. This will take some
# time.
pyenv install 3.5.3
pyenv install 3.6.3
pyenv local 3.6.3 3.5.3
# Install the development dependencies
pip3 install -Ur dev-requirements.txtTo run the unit tests for all supported versions of Python, run tox. If you
made a change to the package requirements (in setup.py or test_requirements.txt)
then you'll need to rebuild the environment. Use tox -r to rebuild them and
run the tests.
Once development is done, as your last commit on the branch you'll want to
change the version number and create a tag for deployment. Please do this via
the bumpversion command. More information on bumpversion and its usage
can be found here, but in most
cases you'll run one of the following commands. Assuming the current version is
1.2.3:
# Change the version to 1.2.4
bumpversion patch
# Change the version to 1.3.0
bumpversion minor
# Change the version to 2.0.0
bumpversion major