initialise repo

This commit is contained in:
Florian Förster 2025-11-05 08:50:05 +01:00
parent 193bb138b1
commit 3ce966cf6c
5 changed files with 2613 additions and 25 deletions

1
.python-version Normal file
View File

@ -0,0 +1 @@
3.11

View File

@ -1,26 +1,6 @@
# Repository Template for Python 3.11 Projects
## Tools for Project and Package Management
[![pdm-managed](https://img.shields.io/endpoint?url=https%3A%2F%2Fcdn.jsdelivr.net%2Fgh%2Fpdm-project%2F.github%2Fbadge.json)](https://pdm-project.org)
[![Ruff](https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/astral-sh/ruff/main/assets/badge/v2.json)](https://github.com/astral-sh/ruff)
Python projects are managed with **PDM** ([link to GitHub Source](https://github.com/pdm-project/pdm)), a PEP-compliant project and dependency management tool.
The applicable settings are contained within the PyProject-TOML file. In order to use a repo which was created with this template is to tell PDM which Python interpreter to use and then to install the whole project into the created virtual environment. If the interpreter is not available you will need to install it via PDM.
```console
pdm use 3.11.11 # example of a given version
pdm install
```
This installs all mandatory development dependencies such as:
- Ruff (formatting and linting)
- pytest (unittest framework)
- coverage.py (measuring test coverage)
- pytest-cov (integration of coverage into pytest)
- pytest-xdist (allows to execute the tests on multiple CPU cores)
- bump-my-version (CLI tool to manage version bumping)
- Nox (Python runner, e.g. to run test suite on multiple Python versions)
- pdoc (to auto-generate documentation from docstrings)
- Jupyterlab and widgets (to perform fast prototyping and enable exploratory data analysis)
# Umbreit Python
Umbreit project Python code

2607
pdm.lock generated Normal file

File diff suppressed because it is too large Load Diff

View File

@ -1,9 +1,9 @@
[project]
name = "py311"
name = "umbreit"
version = "0.1.0"
description = "PLEASE ADD PROJECT DESCRIPTION"
description = "Umbreit's Python-based application"
authors = [
{name = "PLEASE ADD AUTHOR", email = "PLEASE ADD EMAIL ADDRESS"},
{name = "Florian Förster", email = "f.foerster@d-opt.com"},
]
dependencies = []
requires-python = ">=3.11"