more cleanup

Author: caronc

.coveragerc

@@ -616,33 +616,67 @@ spec:
 ```
 
 ## Development Environment
-The following should get you a working development environment to test with:
+The following should get you a working development environment (min requirements are Python v3.12) to test with.
+
+### Setup
 
 ```bash
-# Create a virtual environment in the same directory you
-# cloned this repository to:
-python -m venv .
+# Create and activate a Python 3.12 virtual environment:
+python3.12 -m venv .venv
+. .venv/bin/activate
+
+# Install core dependencies:
 
-# Activate it now:
-. ./bin/activate
+pip install -e '.[dev]'
+```
 
-# install dependencies
-pip install -r dev-requirements.txt -r requirements.txt
+### Running the Dev Server
 
-# Run a dev server (debug mode) accessible from your browser at:
-# -> http://localhost:8000/
+```bash
+# Start the development server in debug mode:
 ./manage.py runserver
+# Then visit: http://localhost:8000/
+```
 
+Or use Docker:
+```bash
+# It's this simple:
+docker compose up
 ```
 
-Some other useful development notes:
+### Quality Assurance and Testing (via Tox)
 
-```bash
-# Check for any lint errors
-flake8 apprise_api
+The project uses `tox` to manage linting, testing, and formatting in a reproducible way.
 
+```bash
 # Run unit tests
+tox -e test
+
+# Test structure; calls ruff under the hood
+tox -e lint
+```
+
+**Note**: You can combine environments, e.g.:
+```bash
+tox -e test,lint
+```
+
+Automatically format your code if possible to pass linting after changes:
+```bash
+tox -e format
+```
+
+### Manual Tools (optional)
+The following also works assuming you have provided all development dependencies (`pip install .[dev]`)
+```bash
+# Run unit tests manually (if needed)
 pytest apprise_api
+
+# Lint code with Ruff
+ruff check .
+
+# Format code with Ruff
+ruff format .
 ```
 
 ## Apprise Integration
@@ -790,4 +824,6 @@ The colon `:` prefix is the switch that starts the re-mapping rule engine.  You
 
 
 ## Metrics Collection & Analysis
+
 Basic Prometheus support added through `/metrics` reference point.
+

README.md

@@ -1,7 +1,7 @@
 services:
-  apprise:
+  apprise-api:
     build: .
-    container_name: apprise
+    container_name: apprise-api
     environment:
       - APPRISE_STATEFUL_MODE=simple
     ports:

docker-compose.yml

@@ -66,14 +66,29 @@ filterwarnings = ["once::Warning"]
 testpaths = ["apprise_api"]
 
 [tool.coverage.run]
-branch = true
-source = ["apprise_api"]
-parallel = true
+data_file = ".coverage-reports/.coverage"
+parallel = false
+concurrency = ["multiprocessing"]
+include = ["apprise_api"]
+omit = [
+  "*apps.py",
+  "*/migrations/*",
+  "*/core/settings/*",
+  "*/*/tests/*",
+  "lib/*",
+  "lib64/*",
+  "*urls.py",
+  "*/core/wsgi.py",
+  "gunicorn.conf.py",
+  "*/manage.py"
+]
+disable_warnings = ["no-data-collected"]
 
 [tool.coverage.report]
 show_missing = true
 skip_covered = true
 skip_empty = true
+fail_under = 75.0
 
 [tool.ruff]
 line-length = 120
@@ -161,3 +176,4 @@ section-order = ["future", "standard-library", "third-party", "first-party", "lo
 
 [tool.ruff.lint.flake8-builtins]
 builtins-ignorelist = ["_"]
+

pyproject.toml

@@ -1,19 +1,33 @@
 [tox]
-envlist = lint, format, qa, coverage
+envlist =
+    clean
+    test
+    lint
+    format
+    qa
+    coverage
+
 skip_missing_interpreters = true
 
+[testenv]
+skip_install = false
+usedevelop = true
+changedir = {toxinidir}
+allowlist_externals = *
+ensurepip = true
+setenv =
+    COVERAGE_RCFILE = {toxinidir}/pyproject.toml
+
 [testenv:lint]
 description = Run Ruff in check-only mode
 deps = ruff
 commands = ruff check apprise_api
-changedir = {toxinidir}
 
 [testenv:format]
-description = Auto-fix lint issues using ruff
+description = Auto-format code using Ruff
 deps = ruff
 skip_install = true
 commands = ruff check --fix apprise_api
-changedir = {toxinidir}
 
 [testenv:qa]
 description = Run test suite and linting with coverage
@@ -22,7 +36,13 @@ deps =
 commands =
     coverage run --parallel -m pytest apprise_api
     ruff check apprise_api
-changedir = {toxinidir}
+
+[testenv:test]
+description = Run test suite only
+deps =
+    .[dev]
+commands =
+    pytest --tb=short -q apprise_api {posargs}
 
 [testenv:coverage]
 description = Generates coverage details
@@ -31,5 +51,4 @@ deps =
 commands =
     coverage combine apprise_api
     coverage report apprise_api
-changedir = {toxinidir}