Set Up

Install instructions

Windows

Install dependencies

Go to python-package-pixiepy root directory. Create and activate python virtual environment:

python -m venv .venv-swiss
.venv-swiss/Scripts/activate.bat

Install package and its dependencies:

pip install -e .[testing]

Running tests

Make sure your environment is activated.

pytest

Sphinx

sphinx-build --color -b html -d "./docs/_build/doctrees" "./docs" "./docs/_build/html"

or

tox -e docs

Publish to Pypi

git tag 0.0.4

python -m twine check dist/*
python -m twine upload dist/*

or

tox -e publish

Pylint

pylint --rcfile=setup.cfg src/swissarmyknife tests

or

tox -e pylint

Flake8

flake8 src/swissarmyknife tests

or

tox -e flake8