[WiP] Testing

.coveragerc

@@ -1,3 +1,4 @@
 [run]
 omit =
     tests/*
+    src/pysatl_experiment/__main__.py

.github/workflows/ci.yaml

@@ -7,14 +7,14 @@ on:
   pull_request:
     branches:
       - main
-    types: [opened, synchronize, reopened, closed, review_requested]
+    types: [ opened, synchronize, reopened, closed, review_requested ]
 
 jobs:
   build-linux:
     runs-on: ubuntu-latest
     strategy:
       matrix:
-        python-version: ["3.10", "3.11", "3.12"]
+        python-version: [ "3.10", "3.11", "3.12" ]
 
     steps:
       - name: Checkout repository

.github/workflows/deploy-docs.yml

@@ -9,7 +9,7 @@ on:
       - main
     types: [ opened, synchronize, reopened, closed, review_requested ]
   release:
-    types: [published]
+    types: [ published ]
 
 
 # disable permissions for all of the available permissions
@@ -41,7 +41,7 @@ jobs:
 
       - name: Install dependencies with Poetry
         run: |
-          poetry install --with dev
+          poetry install --with docs
 
       - name: Fetch gh-pages branch
         run: |

pyproject.toml

@@ -35,6 +35,14 @@ psycopg2 = "2.9.12"
 pysatl-criterion = { version = "*", source = "testpypi", allow-prereleases = true }
 psutil = "^7.1.1"
 
+[tool.poetry.group.docs.dependencies]
+markdown = "3.10.2"
+mkdocs = "1.6.1"
+mkdocs-material = "9.7.6"
+mdx-truly-sane-lists = "1.3"
+pymdown-extensions = "10.21.3"
+mike = "2.2.0"
+
 [tool.poetry.group.dev.dependencies]
 markdown = "3.10.2"
 mkdocs = "1.6.1"
@@ -107,6 +115,12 @@ enable = true
 vcs = "git"
 style = "pep440"
 
+[tool.coverage.run]
+source = ["pysatl_experiment"]
+omit = [
+  "*/__main__.py",
+]
+
 # Format for NON tagged commits
 format-jinja = """
 {%- if distance == 0 -%}

src/pysatl_experiment/loggers/buffering_handler.py

@@ -51,3 +51,6 @@ def flush(self):
             self.buffer = self.buffer[records_to_keep:]  # TODO: replace with queue/circular buffer??
         finally:
             self.release()
+
+
+# TODO: currently not used anywhere

src/pysatl_experiment/loggers/json_formatter.py

@@ -19,6 +19,7 @@
 
 
 # TODO: replace loosely typed dictionaries with a dedicated TypedDict schema for formatter configuration?
+# TODO: currently not used anywhere
 
 
 class JsonFormatter(logging.Formatter):

src/pysatl_experiment/loggers/rich_handler.py

@@ -24,6 +24,9 @@
 from rich.text import Text
 
 
+# TODO: currently not used anywhere
+
+
 class FtRichHandler(Handler):
     """
     Custom Rich-based logging handler for colorized console output.

src/pysatl_experiment/loggers/std_err_stream_handler.py

@@ -91,3 +91,4 @@ def emit(self, record):
 
 
 # TODO: is this handler needed at all instead of StreamHandler? if so, check for tests
+# TODO: currently not used anywhere