Developer’s Guide¶

Prerequisites¶

The qwikstart package uses poetry for dependency management and distribution. You call install poetry using:

curl -sSL https://raw.githubusercontent.com/sdispater/poetry/master/get-poetry.py | python

Clone from github:

git clone https://github.com/tonysyu/qwikstart.git

Install development requirements:

cd qwikstart
poetry install

For building the documentation locally, you’ll also need to run:

poetry install --extras "docs"

For local development, you’ll also want to install pre-commit hooks using:

poetry run pre-commit install

By default, this will run the black code formatter on changed files on every commit. To run black on all files:

poetry run pre-commit run --all-files

The test suite can be run without installing dev requirements using:

$ tox

To run tests with a specific Python version, run:

$ tox --env py36

You can isolate specific test files/functions/methods with:

tox PATH/TO/TEST.py
tox PATH/TO/TEST.py::TEST_FUNCTION
tox PATH/TO/TEST.py::TEST_CLASS::TEST_METHOD

Documentation is built from within the docs directory:

cd docs
poetry run make html

After building, you can view the docs at docs/_build/html/index.html.

A reminder for the maintainers on how to deploy.

Update the version and push:

$ poetry run bumpversion --tag release  # possible: major / minor / patch / build
$ git push
$ git push --tags

Build release and deploy to PyPI:
```
$ poetry build
$ poetry publish
```
Update version to the next planned version (without release argument, this will add a -dev0 suffix):
```
$ poetry run bumpversion minor  # possible: major / minor / patch / build
```