Contributing

Code of Conduct

Before contributing, please take time to review our code of conduct here.

$ git clone https://github.com/ebenh/django-flex-user/ django-flex-user

Refer to the docs here to learn how to set up the Django project.

Add dependencies with the following command:

$ python3 -m pipenv install [--dev] [package]

After installing the dependency make sure to manually add it to tox.ini and requirements.txt.

$ tox -e coverage

$ tox -e static

Install and/or upgrade twine.

 $ python3 -m pip install --upgrade twine

Upload the package to the PyPI test repository.
```
 $ python3 -m twine upload --repository testpypi dist/*
```
Note: Username is __token__ and password is your token for the test repository (make sure to include the pypi- prefix).
Test the package you just uploaded to the PyPI test repository. The value of ${VERSION} should be the package's current semantic version (e.g. 1.0.0).
```
 $ python3 -m pip install --user django-flex-user/dist/django-flex-user-${VERSION}.tar.gz
```
If the above command completes without errors, bump the version number, tag the release and commit.
```
 $ bumpversion [major|minor|patch] && git push --tags
```
Build the Python package again in order to capture the latest version number.
```
 $ python setup.py sdist
```
If the above commands execute without any errors, you're ready to upload the library to PyPI. The value of ${VERSION} should be the package's latest semantic version (e.g. 2.0.0).
```
 $ python3 -m twine upload dist/django-flex-user-${VERSION}.tar.gz
```
Note: Username is __token__ and password is your PyPI token (make sure to include the pypi- prefix).
Optionally, clean your working tree.
```
 $ git clean -idx
```