pxl-th/python-package-template

Python Package Template

Python Package Template

Contains minimal python package structure.

Table of contents

• How to install
• Run tests
• Build documentation
• Update version tag

How to install

To install package, execute

pip install .

or install a project in editable mode

pip install -e .[dev]

Run tests

To run tests, execute

python setup.py test

Build documentation

If you are building documentation for the first time, or you have changed package structure, execute

sphinx-apidoc -o docs/ template

Note if there are no changes, then you should delete files, that already exist in the list produced by command above. And then execute

python setup.py build_sphinx

Update version tag

• Update version variables in setup.py and __init__ files.
• Commit changes, but do not push.
• Create tag with new version git tag -a "v{new_version}" and add a corresponding section from CHANGELOG to its description.
• Push changes following tags git push --follow-tags.