DEVELOP.md

Set up development environment

Clone repository (fork and clone your own repo for contributions) and install project with Poetry

$ git clone [email protected]:bmwant/leak.git
$ cd leak
$ poetry install

Set LEAK_DEBUG environment variable for the extra internal logging while developing

$ export LEAK_DEBUG=1
$ poetry run leak requests

Testing

Unittests are written using pytest.

$ poetry run pytest -sv tests
# or
$ make tests

or to test on all possible environments

$ poetry run tox

Releasing

Bump a version with features you want to include and build a package

$ poetry version patch  # patch version update
$ poetry version minor
$ poetry version major  # choose one based on semver rules
$ poetry build  # just builds a package
$ make release  # clean + build + publish

Upload package to GitHub and PyPI

$ git tag -a 1.3.0 -m "Version 1.3.0"
$ git push --tags
$ poetry publish  # only uploads package to PyPI