refactoring next part

Author: HeinrichAD

.github/dependabot.yml

@@ -0,0 +1,31 @@
+# SPDX-FileCopyrightText: 2026 German Aerospace Center (DLR)
+# SPDX-License-Identifier: CC0-1.0
+#
+# Please see the documentation for all configuration options:
+# https://docs.github.com/github/administering-a-repository/configuration-options-for-dependency-updates
+
+version: 2
+updates:
+  # Maintain dependencies for Python packages
+  - package-ecosystem: pip
+    directory: /
+    schedule:
+      interval: monthly
+
+  # Maintain dependencies inside uv lock file
+  - package-ecosystem: uv
+    directory: /
+    schedule:
+      interval: monthly
+
+  # Maintain dependencies for GitHub actions
+  - package-ecosystem: github-actions
+    directory: /
+    schedule:
+      interval: monthly
+
+  # Maintain dependencies for pre-commit config
+  - package-ecosystem: pre-commit
+    directory: /
+    schedule:
+      interval: monthly

.github/workflows/main.yml

@@ -27,7 +27,7 @@ jobs:
       - uses: actions/checkout@v6
       - uses: actions/setup-node@v6
       - name: Install dependencies
-        run: npm install markdownlint-cli2
+        run: npm install --no-save "markdownlint-cli2@0.22.0"
       - name: Start type checking
         run: bash ./dev lint-doc
 
@@ -155,6 +155,8 @@ jobs:
   build-pages:
     needs: [lint-code, lint-doc, lint-scripts, mypy, coverage, license-check]
     runs-on: ubuntu-latest
+    environment:
+      DEPLOY: true
     steps:
       - uses: actions/checkout@v6
       - name: Install uv

.pre-commit-config.yaml

@@ -7,6 +7,6 @@ repos:
     hooks:
       - id: flake8
   - repo: https://github.com/pre-commit/mirrors-mypy
-    rev: v1.19.1
+    rev: v1.20.0
     hooks:
       - id: mypy

README.md

@@ -29,46 +29,16 @@ They offer a more user-friendly interface and comprehensive guides to get you st
 
 ## Requirements
 
-### Python > 3.10
-
-```bash
-sudo apt install python<version>
-#If not available you can add latest versions with
-sudo add-apt-repository ppa:deadsnakes/ppa 
-```
-
-### Venv
-
-```bash
-#Install venv
-sudo apt install python<version>-venv
-```
-
-### Virtualenv (alternative to venv)
-
-```bash
-#python 3.10 or later
-which python
-#virtualenv or venv
-pip install -U virtualenv
-```
+- Python 3.10 or later  
+  `which python`
+- [uv](https://docs.astral.sh/uv/)  
+  `curl -LsSf https://astral.sh/uv/install.sh | sh`
 
 ## Install
 
 ```bash
-# create virtual environment
-virtualenv -p $(which python<version>) .venv
-# or
-python<version> -m venv .venv
-
-# activate our virtual environment
-source .venv/bin/activate
-
-# update pip (optional)
-python -m pip install -U pip
-
-# install
-./dev install -U -e ".[all]"
+# create virtual environment and install dependencies
+./dev install
 ```
 
 ## Helpers

dev

@@ -93,8 +93,11 @@ function version() {
 
 function versions() {
   info "versions"
-  # info "$(python --version)" <- not necessarily the uv python
-  info "$(uv --version)"
+  if ! command -v docker > /dev/null 2>&1; then
+    warn "uv not found, skipping uv version"
+  else
+    info "uv version: $(uv --version)"
+  fi
   if ! command -v docker > /dev/null 2>&1; then
     warn "docker not found, skipping docker version"
   else
@@ -116,13 +119,7 @@ function install() {
     curl -LsSf https://astral.sh/uv/install.sh | sh
   fi
   info "install package"
-  uv sync --editable --all-extras
-  info "install markdown linter"
-  if command -v npm > /dev/null 2>&1; then
-    npm install --no-save markdownlint-cli2
-  else
-    warn "npm not found, skipping markdownlint-cli2 installation"
-  fi
+  uv sync --all-extras
 }
 
 function clean() {
@@ -253,14 +250,14 @@ function lint-doc() {
   info "lint documentation"
   # use markdownlint from David Anson (based on nodejs)
   # https://github.com/DavidAnson/markdownlint
-  npm exec "markdownlint-cli2@0.22.0" "${DOC_ROOT}/**/*.md" "${PROJECT_ROOT}/README.md"
+  npm exec "markdownlint-cli2@0.22.0" -- "${DOC_ROOT}/**/*.md" "${PROJECT_ROOT}/README.md"
 }
 
 function lint-scripts() {
   info "lint bash scripts"
-  info "shellcheck $(shellcheck --version | head -n 2 | tail -n 1)"
-  shellcheck --external-sources --shell bash --source-path "${PROJECT_ROOT}" "${PROJECT_ROOT}/dev"
-  shellcheck --external-sources --shell bash --source-path "${SCRIPTS_ROOT}" "${SCRIPTS_ROOT}/"*.sh
+  info "shellcheck $(uv run shellcheck --version | head -n 2 | tail -n 1)"
+  uv run shellcheck --external-sources --shell bash --source-path "${PROJECT_ROOT}" "${PROJECT_ROOT}/dev"
+  uv run shellcheck --external-sources --shell bash --source-path "${SCRIPTS_ROOT}" "${SCRIPTS_ROOT}/"*.sh
 }
 
 function mypy() {
@@ -328,10 +325,6 @@ function safety-check() {
   info "check dependencies for known security vulnerabilities"
   # main only no dev dependencies etc.
   uv run tox --recreate -e safety
-  # alternative
-  #uv pip install -U safety
-  #safety check
-  ##uv pip uninstall safety
 }
 
 

pyproject.toml

@@ -6,9 +6,7 @@
 # package, this name will be registered for you. It will determine how
 # users can install this project, e.g.:
 #
-# $ uv sync fl-demonstrator
-#
-# And where it will live on PyPI: https://pypi.org/project/fl-demonstrator/
+# $ uv add "fl-demonstrator @ git+https://github.com/DLR-KI/fl-demonstrator.git"
 #
 # There are some restrictions on what makes a valid project name
 # specification here:
@@ -133,7 +131,7 @@ dependencies = [ # Optional
 # dependencies). Users will be able to install these using the "extras"
 # syntax, for example:
 #
-#   $ uv sync --editable --all-extras
+#   $ uv sync --all-extras
 #
 # Similar to `dependencies` above, these must be valid existing
 # projects.