MoritzM00 / python-template-demo

Light-weight Python Template

A Demo for the light-weight python template.

Quick Start

Below you can find the quick start guide for development.

Set up the environment

1. Install Poetry
2. Set up the environment:

make setup
make activate

Additional first-time setup

1. After setting up the environment, commit the poetry.lock file to your repository, so that the workflow on github can use it.
2. Enable Pre-Commit CI for your repository.
3. Enable Github Pages for your documentation. To do that, go to the Settings tab of your repository and scroll down to the GitHub Pages section. For the Source option, select GitHub Action. Done!

Install new packages

To install new PyPI packages, run:

poetry add <package-name>

To add dev-dependencies, run:

poetry add <package-name> --group dev

Documentation

The Documentation is automatically deployed to GitHub Pages.

To view the documentation locally, run:

make docs_view

Credits

This project was generated with the Light-weight Python Template by Moritz Mistol.