Refactored code base; modernized with pyproject.toml (#255)

Author: caronc

.coveragerc

@@ -1,9 +1,9 @@
 ## Description:
-**Related issue (if applicable):** refs #<!--apprise issue number goes here-->
+**Related issue (if applicable):** refs #<!--apprise-api issue number goes here-->
 
 ## Checklist
 <!-- The following must be completed or your PR can't be merged -->
 * [ ] The code change is tested and works locally.
 * [ ] There is no commented out code in this PR.
-* [ ] No lint errors (use `flake8`)
+* [ ] No lint errors (use `ruff`)
 * [ ] Tests added

.github/PULL_REQUEST_TEMPLATE.md

@@ -1,71 +1,55 @@
+# Copyright (C) 2025 Chris Caron <[email protected]>
+# All rights reserved.
+#
+# This code is licensed under the MIT License.
+#
+# Permission is hereby granted, free of charge, to any person obtaining a copy
+# of this software and associated documentation files(the "Software"), to deal
+# in the Software without restriction, including without limitation the rights
+# to use, copy, modify, merge, publish, distribute, sublicense, and / or sell
+# copies of the Software, and to permit persons to whom the Software is
+# furnished to do so, subject to the following conditions :
+#
+# The above copyright notice and this permission notice shall be included in
+# all copies or substantial portions of the Software.
+#
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.IN NO EVENT SHALL THE
+# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+# THE SOFTWARE.
 name: Tests
 
 on:
-
-  # On which repository actions to trigger the build.
   push:
     branches: [ master ]
   pull_request:
     branches: [ master ]
-
-  # Allow job to be triggered manually.
   workflow_dispatch:
 
-# Cancel in-progress jobs when pushing to the same branch.
-concurrency:
-  cancel-in-progress: true
-  group: ${{ github.workflow }}-${{ github.ref }}
-
 jobs:
-
   tests:
+    runs-on: ubuntu-latest
 
-    runs-on: ${{ matrix.os }}
-    strategy:
-
-      # Run all jobs to completion (false), or cancel
-      # all jobs once the first one fails (true).
-      fail-fast: true
-
-      # Define a minimal test matrix, it will be
-      # expanded using subsequent `include` items.
-      matrix:
-        os: ["ubuntu-latest"]
-        python-version: ["3.12"]
-        bare: [false]
-
-    defaults:
-      run:
-        shell: bash
-
-    env:
-      OS: ${{ matrix.os }}
-      PYTHON: ${{ matrix.python-version }}
-      BARE: ${{ matrix.bare }}
-
-    name: Python ${{ matrix.python-version }} on ${{ matrix.os }} ${{ matrix.bare && '(bare)' || '' }}
     steps:
-
     - name: Acquire sources
       uses: actions/checkout@v4
 
-    - name: Install prerequisites (Linux)
-      if: runner.os == 'Linux'
+    - name: Install prerequisites
       run: |
         sudo apt-get update
 
-    - name: Install project dependencies (Baseline)
+    - name: Install dependencies
       run: |
         pip install -r requirements.txt -r dev-requirements.txt
 
-    # For saving resources, code style checking is
-    # only invoked within the `bare` environment.
-    - name: Check code style
-      if: matrix.bare == true
+    - name: Lint with Ruff
       run: |
-        flake8 apprise_api --count --show-source --statistics
+        ruff check apprise_api
 
-    - name: Run tests
+    - name: Run tests with coverage
       run: |
         coverage run -m pytest apprise_api
 
@@ -74,9 +58,10 @@ jobs:
         coverage xml
         coverage report
 
-    - name: Upload coverage data
+    - name: Upload coverage to Codecov
       uses: codecov/codecov-action@v5
       with:
         files: ./coverage.xml
         fail_ci_if_error: false
         token: ${{ secrets.CODECOV_TOKEN }}
+

.github/workflows/tests.yml

@@ -16,6 +16,7 @@ dist/
 downloads/
 eggs/
 .eggs/
+.local/
 lib64
 lib
 var/

.gitignore

@@ -2,7 +2,7 @@
 # BSD 2-Clause License
 #
 # Apprise-API - Push Notification Library.
-# Copyright (c) 2023, Chris Caron <[email protected]>
+# Copyright (c) 2025, Chris Caron <[email protected]>
 #
 # Redistribution and use in source and binary forms, with or without
 # modification, are permitted provided that the following conditions are met:

Dockerfile.py312

@@ -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,4 +1,3 @@
-# -*- coding: utf-8 -*-
 #
 # Copyright (C) 2019 Chris Caron <[email protected]>
 # All rights reserved.
@@ -26,4 +25,4 @@
 
 
 class ApiConfig(AppConfig):
-    name = 'api'
+    name = "api"

apprise_api/api/apps.py

@@ -1,4 +1,3 @@
-# -*- coding: utf-8 -*-
 #
 # Copyright (C) 2020 Chris Caron <[email protected]>
 # All rights reserved.
@@ -22,49 +21,50 @@
 # LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 # OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
 # THE SOFTWARE.
-from .utils import gen_unique_config_id
-from .utils import ConfigCache
 from django.conf import settings
+
 import apprise
 
+from .utils import ConfigCache, gen_unique_config_id
+
 
 def stateful_mode(request):
     """
     Returns our loaded Stateful Mode
     """
-    return {'STATEFUL_MODE': ConfigCache.mode}
+    return {"STATEFUL_MODE": ConfigCache.mode}
 
 
 def config_lock(request):
     """
     Returns the state of our global configuration lock
     """
-    return {'CONFIG_LOCK': settings.APPRISE_CONFIG_LOCK}
+    return {"CONFIG_LOCK": settings.APPRISE_CONFIG_LOCK}
 
 
 def admin_enabled(request):
     """
     Returns whether we allow the config list to be displayed
     """
-    return {'APPRISE_ADMIN': settings.APPRISE_ADMIN}
+    return {"APPRISE_ADMIN": settings.APPRISE_ADMIN}
 
 
 def apprise_version(request):
     """
     Returns the current version of apprise loaded under the hood
     """
-    return {'APPRISE_VERSION': apprise.__version__}
+    return {"APPRISE_VERSION": apprise.__version__}
 
 
 def default_config_id(request):
     """
     Returns a unique config identifier
     """
-    return {'DEFAULT_CONFIG_ID': request.default_config_id}
+    return {"DEFAULT_CONFIG_ID": request.default_config_id}
 
 
 def unique_config_id(request):
     """
     Returns a unique config identifier
     """
-    return {'UNIQUE_CONFIG_ID': gen_unique_config_id()}
+    return {"UNIQUE_CONFIG_ID": gen_unique_config_id()}