initialise project and update metadata

This commit is contained in:
Florian Förster 2025-10-02 09:16:39 +02:00
parent 6aa92ddf33
commit fc201b7677
4 changed files with 2618 additions and 23 deletions

1
.python-version Normal file
View File

@ -0,0 +1 @@
3.11

View File

@ -1,26 +1,8 @@
# 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) [![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) [![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. # EKF Diagnostic: Sensor Anomalies
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 This project aims to perform anomaly detection on sensor images with a CLI application.
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)
*Further information is provided at later project stages.*

2611
pdm.lock generated Normal file

File diff suppressed because it is too large Load Diff

View File

@ -1,9 +1,9 @@
[project] [project]
name = "py311" name = "py311"
version = "0.1.0" version = "0.1.0"
description = "PLEASE ADD PROJECT DESCRIPTION" description = "anomaly detection for sensor images for quality assurance processes"
authors = [ authors = [
{name = "PLEASE ADD AUTHOR", email = "PLEASE ADD EMAIL ADDRESS"}, {name = "d-opt GmbH", email = "f.foerster@d-opt.com"},
] ]
dependencies = [] dependencies = []
requires-python = ">=3.11" requires-python = ">=3.11"
@ -143,6 +143,7 @@ dev = [
"pdoc3>=0.11.5", "pdoc3>=0.11.5",
"bump-my-version>=1.1.1", "bump-my-version>=1.1.1",
"nox>=2025.2.9", "nox>=2025.2.9",
"cython>=3.1.4",
] ]
nb = [ nb = [
"jupyterlab>=4.3.5", "jupyterlab>=4.3.5",