This template contains the standard structure for a Python repository for the Glacier project. The template is designed to be used as a starting point for new python projects with support for dockerized development and deployment.

• Use this template > Create a new repository : You can clone this template from the UI by clicking on the upper left repository button.
• Use this template > Open in codespace : Alternatively, you can directly try it out in Github codespace. Codespace is a Github feature that allows you to develop directly in the cloud using VSCode devcontainer. For more information, please refer to Github Codespace.
• git clone git@github.com:esd-univr/python-template.git : Or, you can clone this template from the command line.

Once the project cloned, you can install the project dependencies. For development, you can use the dev extra to install the development dependencies.

uv sync --extra dev

or using pip:

pip install -e .[dev]
# install python extension for .env file
pip install python-dotenv
# Note: the .env file must be loaded manually in the main script (https://pypi.org/project/python-dotenv/)

This template includes the following software and tools:

• uv - A Python package and project manager.
• Ruff - A Python linter and code formatter.
• MyPy - Static type checker for Python. It ensures that the variables and functions are used correctly.
• Pytest - Python testing framework. It is used to write and run tests for the project.
• Tox - A tool for automating and standardizing testing in Python. It is used to run the tests with multiple Python versions, check the code quality, and build the documentation.
• Pre-commit - A framework for managing and maintaining multi-language pre-commit hooks. It is used to enforce a consistent code style and quality in each commit.
• Containers - Containers are a standard unit of software that packages up code and all its dependencies into a single container image. This, simplifies the deployment process of the application across different computing environments.
• Devcontainer - VS Code extension that allows you to use a Docker container as a full-featured development environment.
• Sphinx - Python documentation generator. It is used to generate the documentation of the project (API, tutorials, examples, etc.).
• GitHub Actions - Automate, customize, and execute your software development workflows in your repository. Actions are used to run the tests, check the code quality, build the documentation, building the library and publish it to packages repositories (e.g. PyPi), and much more.