README.md

Example repository (Python)

This git repository is a minimal example to show how to structure a Python package, and how to use GitHub Actions to automatically run tests and build documentation for your software.

Install the package

Create a new environment will all dependencies and make it the active environment

conda env create -f environment.yml
conda activate mypackage

Inspect information about the environment and list all installed packages

conda info
conda list

Install our own package in the environment

python3 -m pip install .

Run tests

Run the test suite

pytest .

Build documentation

Auto-generate documentation

cd docs/
make html

The generated HTML files are stored in docs/build/html.

When commits are pushed or merged to the remote repository, a new version of the documentation is build and published on GitHub pages.

---

Further information

• Setuptools - library to facilitate packaging Python projects
• Sphinx - Python documentation generator
• pytest - A full-featured Python testing framewor
• GitHub Actions - automate your software workflows
• GitHub Pages - Host web sites directly from your repository