Installation Guide

Explain how your package can be installed. As we use the PyPI approach here, you will most likely want to show the pip installation. It is also recommended to show how your package can be install from source, as some users prefer downloading code from github.


The lastest stable version can be found on PyPI and installed via pip.

pip install package_template


A more recent version might be available on GitHub.

git clone
cd package-template
pip install -r requirements.txt
pip install -e .

Using this Template


The above section gave an example, how a installation guide for this package would look like. In case you are planning to use this package as a template for your own code, please refer to the Howto Guide.