Integration branch for FastAPI and other PRs

.github/workflows/pytest.yml

@@ -16,7 +16,7 @@ jobs:
       - name: Set up Python
         uses: actions/setup-python@v5
         with:
-          python-version: '3.12'
+          python-version: "3.12"
 
       - name: Install dependencies
         run: |
@@ -26,4 +26,4 @@ jobs:
       - name: Run Pytest
         run: |
           pip install -e .
-          python -m pytest -vs --cov modules --cov-report term-missing tests/
+          python -m pytest -vs --cov src --cov-report term-missing tests/

.gitignore

@@ -4,9 +4,7 @@ output/
 # Default ignore folders and files for VS Code, Python
 
 .vscode/*
-!.vscode/settings.json
-!.vscode/tasks.json
-!.vscode/launch.json
+!.vscode/*.shared.json
 !.vscode/extensions.json
 !.vscode/*.code-snippets
 
@@ -69,6 +67,9 @@ coverage.xml
 .pytest_cache/
 cover/
 
+# Documentation generation
+_autosummary/
+
 # Translations
 *.mo
 *.pot
@@ -248,3 +249,6 @@ $RECYCLE.BIN/
 
 # Visualization side effects
 **/visualization_results.pdf
+
+# Test files
+openapi-new.json

.pre-commit-config.yaml

@@ -1,24 +1,24 @@
 # Exclude some file types from automatic code style
 exclude: \.(json|csv)$
 repos:
-- repo: https://github.com/pre-commit/pre-commit-hooks
-  rev: v4.6.0
-  hooks:
-    - id: check-merge-conflict
-    - id: check-toml
-    - id: check-yaml
-    - id: end-of-file-fixer
-    - id: trailing-whitespace
-- repo: https://github.com/PyCQA/isort
-  rev: 5.13.2
-  hooks:
-    - id: isort
-      name: isort
-- repo: https://github.com/astral-sh/ruff-pre-commit
-  rev: v0.6.8
-  hooks:
-    # Run the linter and fix simple issues automatically
-    - id: ruff
-      args: [ --fix ]
-    # Run the formatter.
-    - id: ruff-format
+  - repo: https://github.com/pre-commit/pre-commit-hooks
+    rev: v4.6.0
+    hooks:
+      - id: check-merge-conflict
+      - id: check-toml
+      - id: check-yaml
+      - id: end-of-file-fixer
+      - id: trailing-whitespace
+  - repo: https://github.com/PyCQA/isort
+    rev: 5.13.2
+    hooks:
+      - id: isort
+        name: isort
+  - repo: https://github.com/astral-sh/ruff-pre-commit
+    rev: v0.6.8
+    hooks:
+      # Run the linter and fix simple issues automatically
+      - id: ruff
+        args: [--fix]
+      # Run the formatter.
+      - id: ruff-format

.vscode/extensions.json

@@ -0,0 +1,14 @@
+{
+  "recommendations": [
+    //python
+    "ms-python.python",
+    "ms-python.debugpy",
+    "charliermarsh.ruff",
+    "ms-python.mypy-type-checker",
+
+    // misc
+    "swellaby.workspace-config-plus", // allows user and shared settings
+    "christian-kohler.path-intellisense",
+    "esbenp.prettier-vscode"
+  ]
+}

.vscode/settings.shared.json

@@ -0,0 +1,13 @@
+{
+  "[python]": {
+    "editor.defaultFormatter": "charliermarsh.ruff"
+  },
+  "editor.defaultFormatter": "esbenp.prettier-vscode",
+  "editor.defaultFoldingRangeProvider": "charliermarsh.ruff",
+  "editor.formatOnSave": true,
+  "python.analysis.autoImportCompletions": true,
+  "mypy-type-checker.importStrategy": "fromEnvironment",
+  "python.testing.pytestArgs": [],
+  "python.testing.unittestEnabled": false,
+  "python.testing.pytestEnabled": true
+}

CONTRIBUTING.md

@@ -6,7 +6,7 @@ The `EOS` project is in early development, therefore we encourage contribution i
 
 ## Bug Reports
 
-Please report flaws or vulnerabilities in the [GitHub Issue Tracker]((https://github.com/Akkudoktor-EOS/EOS/issues)) using the corresponding issue template.
+Please report flaws or vulnerabilities in the [GitHub Issue Tracker](https://github.com/Akkudoktor-EOS/EOS/issues) using the corresponding issue template.
 
 ## Ideas & Features
 
@@ -44,5 +44,5 @@ pre-commit run --all-files
 Use `pytest` to run tests locally:
 
 ```bash
-python -m pytest -vs --cov modules --cov-report term-missing tests/
+python -m pytest -vs --cov src --cov-report term-missing tests/
 ```

Dockerfile

@@ -30,6 +30,6 @@ COPY src .
 USER eos
 ENTRYPOINT []
 
-CMD ["python", "-m", "akkudoktoreosserver.flask_server"]
+CMD ["python", "-m", "akkudoktoreosserver.fastapi_server"]
 
 VOLUME ["${MPLCONFIGDIR}", "${EOS_CACHE_DIR}", "${EOS_OUTPUT_DIR}"]

Makefile

@@ -1,5 +1,5 @@
 # Define the targets
-.PHONY: help venv pip install dist test docker-run docs clean
+.PHONY: help venv pip install dist test docker-run docker-build docs read-docs clean format run run-dev
 
 # Default target
 all: help
@@ -10,10 +10,12 @@ help:
 	@echo "  venv         - Set up a Python 3 virtual environment."
 	@echo "  pip          - Install dependencies from requirements.txt."
 	@echo "  pip-dev      - Install dependencies from requirements-dev.txt."
+	@echo "  format       - Format source code."
 	@echo "  install      - Install EOS in editable form (development mode) into virtual environment."
 	@echo "  docker-run   - Run entire setup on docker"
 	@echo "  docker-build - Rebuild docker image"
 	@echo "  docs         - Generate HTML documentation (in build/docs/html/)."
+	@echo "  read-docs    - Read HTML documentation in your browser."
 	@echo "  run          - Run flask_server in the virtual environment (needs install before)."
 	@echo "  dist         - Create distribution (in dist/)."
 	@echo "  clean        - Remove generated documentation, distribution and virtual environment."
@@ -51,15 +53,26 @@ docs: pip-dev
 	.venv/bin/sphinx-build -M html docs build/docs
 	@echo "Documentation generated to build/docs/html/."
 
+# Target to read the HTML documentation
+read-docs: docs
+	@echo "Read the documentation in your browser"
+	.venv/bin/python -m webbrowser build/docs/html/index.html
+
 # Clean target to remove generated documentation, distribution and virtual environment
 clean:
-	@echo "Cleaning virtual env, distribution and documentation directories"
-	rm -rf dist
-	rm -rf .venv
+	@echo "Cleaning virtual env, distribution and build directories"
+	rm -rf dist build .venv
+	@echo "Searching and deleting all '_autosum' directories in docs..."
+	@find docs -type d -name '_autosummary' -exec rm -rf {} +;
+	@echo "Deletion complete."
 
 run:
-	@echo "Starting flask server, please wait..."
-	.venv/bin/python -m akkudoktoreosserver.flask_server
+	@echo "Starting FastAPI server, please wait..."
+	.venv/bin/python -m akkudoktoreosserver.fastapi_server
+
+run-dev:
+	@echo "Starting FastAPI development server, please wait..."
+	.venv/bin/fastapi dev src/akkudoktoreosserver/fastapi_server.py
 
 # Target to setup tests.
 test-setup: pip-dev
@@ -68,7 +81,11 @@ test-setup: pip-dev
 # Target to run tests.
 test:
 	@echo "Running tests..."
-	.venv/bin/pytest
+	.venv/bin/pytest -vs --cov src --cov-report term-missing
+
+# Target to format code.
+format:
+	pre-commit run --all-files
 
 # Run entire setup on docker
 docker-run:

NOTICE

@@ -17,7 +17,7 @@ This product may utilize technologies covered under international patents and/or
 
 ADDITIONAL ATTRIBUTIONS:
 The following is a list of licensors and other acknowledgements for third-party software that may be contained within this system:
-- Flask, licensed under the BSD License, see https://flask.palletsprojects.com/
+- FastAPI, licensed under the MIT License, see https://fastapi.tiangolo.com/
 - NumPy, licensed under the BSD License, see https://numpy.org/
 - Requests, licensed under the Apache License 2.0, see https://requests.readthedocs.io/
 - matplotlib, licensed under the matplotlib License (a variant of the Python Software Foundation License), see https://matplotlib.org/