more massive refactoring

Author: caronc

.github/workflows/lint.yml

@@ -0,0 +1,28 @@
+# .github/workflows/lint.yml
+name: Run Lint Checks
+
+on:
+  push:
+    paths:
+      - '**.py'
+  pull_request:
+    paths:
+      - '**.py'
+
+jobs:
+  lint:
+    runs-on: ubuntu-latest
+
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Set up Python
+        uses: actions/setup-python@v5
+        with:
+          python-version: '3.12'
+
+      - name: Install tox
+        run: python -m pip install tox
+
+      - name: Run Ruff lint check
+        run: tox -e lint

.github/workflows/tests.yml

@@ -13,57 +13,43 @@ on:
 jobs:
   test:
     name: Python ${{ matrix.python-version }} – ${{ matrix.tox_env }} on ${{ matrix.os }}
-    runs-on: ubuntu-latest
+    runs-on: ${{ matrix.os || 'ubuntu-latest' }}
 
     strategy:
       fail-fast: false  # Let all jobs run, even if one fails
       matrix:
         include:
-          - python-version: "3.8"
-            tox_env: qa
-            setup_python: true
-
-          # Modern Python versions (can rely on default runner environment)
           - python-version: "3.9"
             tox_env: qa
-            setup_python: false
           - python-version: "3.10"
             tox_env: qa
-            setup_python: false
           - python-version: "3.11"
             tox_env: qa
-            setup_python: false
           - python-version: "3.12"
             tox_env: qa
-            setup_python: false
+
+          # Pre-release testing (won't fail entire workflow if this fails)
+          - python-version: "3.13-dev"
+            tox_env: qa
+            continue-on-error: true
 
           # Platform validation only (one version)
           - os: windows-latest
-            python-version: "3.11"
+            python-version: "3.12"
             tox_env: qa
 
           - os: macos-latest
-            python-version: "3.11"
+            python-version: "3.12"
             tox_env: qa
 
           # Minimal test run on latest Python only
           # this verifies Apprise still works when extra libraries are not available
           - python-version: "3.12"
             tox_env: minimal
-            setup_python: false
-
 
     steps:
       - uses: actions/checkout@v4
 
-      # Legacy Python versions 3.8 are no longer on GitHub-hosted runners
-      # Use setup-python to install them explicitly
-      - name: Set up Python (legacy)
-        if: matrix.setup_python
-        uses: actions/setup-python@v5
-        with:
-          python-version: ${{ matrix.python-version }}
-
       # Install tox for isolated environment and plugin test orchestration
       - name: Install tox
         run: python -m pip install tox
@@ -72,13 +58,6 @@ jobs:
       - name: Run tox for ${{ matrix.tox_env }}
         run: tox -e ${{ matrix.tox_env }}
 
-      - name: Verify .coverage file existence
-        if: always()
-        run: |
-          echo "::group::Looking for .coverage file"
-          ls -alh .
-          echo "::endgroup::"
-
       - name: Upload coverage report
         if: always()
         uses: actions/upload-artifact@v4

.gitignore

@@ -18,6 +18,8 @@ env/
 .venv*
 build/
 BUILDROOT/
+SOURCES/
+SRPMS/
 develop-eggs/
 dist/
 downloads/

CONTRIBUTIONS.md ACKNOWLEDGEMENTS.mdCONTRIBUTIONS.md renamed to ACKNOWLEDGEMENTS.md

@@ -1,4 +1,4 @@
-# Contributions to the apprise project
+# Contributions to the Apprise Project
 
 ## Creator & Maintainer
 

CONTRIBUTING.md

@@ -0,0 +1,61 @@
+# 🤝 Contributing to Apprise
+
+Thank you for your interest in contributing to Apprise!
+
+We welcome bug reports, feature requests, documentation improvements, and new
+notification plugins. Please follow the guidelines below to help us review and
+merge your contributions smoothly.
+
+---
+
+## ✅ Quick Checklist Before You Submit
+
+- ✔️ Your code passes all lint checks:
+  ```bash
+  tox -e lint
+  ```
+
+- ✔️ Your changes are covered by tests:
+  ```bash
+  tox -e qa
+  ```
+
+- ✔️ All tests pass locally.
+
+- ✔️ Your code is clean and consistently formatted:
+  ```bash
+  tox -e format
+  ```
+
+- ✔️ You followed the plugin template (if adding a new plugin).
+- ✔️ You included inline docstrings and respected the BSD 2-Clause license.
+- ✔️ Your commit message is descriptive.
+
+---
+
+## 📌 How to Contribute
+
+1. **Fork the repository** and create a new branch.
+2. Make your changes.
+3. Run the checks listed above.
+4. Submit a pull request (PR) to the `main` branch.
+
+GitHub Actions will run tests and lint checks on your PR automatically.
+
+---
+
+## 🧪 Need Help with Testing or Plugins?
+
+See [DEVELOPMENT.md](./DEVELOPMENT.md) for:
+- Full setup instructions
+- Tox environment descriptions
+- RPM testing
+- Plugin development guidance
+
+---
+
+## 🙏 Thank You
+
+Your contributions make Apprise better for everyone — thank you!
+
+📝 See [ACKNOWLEDGEMENTS.md](./ACKNOWLEDGEMENTS.md) for a list of contributors.

MANIFEST.in

@@ -1,5 +1,7 @@
 include LICENSE
 include README.md
+include CONTRIBUTING.md
+include ACKNOWLEDGEMENTS.md
 include pyproject.toml
 include tox.ini
 include requirements.txt

README.md

@@ -207,7 +207,7 @@ Apprise have some email services built right into it (such as yahoo, fastmail, h
 
 # Installation
 
-The easiest way is to install this package is from pypi:
+The easiest way is to install Apprise from PyPI:
 ```bash
 pip install apprise
 ```
@@ -223,7 +223,7 @@ yum install apprise
 dnf install apprise
 ```
 
-You can also check out the [Graphical version of Apprise](https://github.com/caronc/apprise-api) to centralize your configuration and notifications through a managable webpage.
+You can also check out the [Graphical version of Apprise](https://github.com/caronc/apprise-api) to centralize your configuration and notifications through a manageable webpage.
 
 # Command Line Usage
 
@@ -356,7 +356,7 @@ apprise -vv --title 'custom override' \
         --body 'the body of my message' \
         foobar:\\
 
-# However you can over-ride the path like so
+# However you can override the path like so
 apprise -vv --title 'custom override' \
         --body 'the body of my message' \
         --plugin-path /path/to/my/plugin.py \
@@ -371,10 +371,10 @@ Those using the Command Line Interface (CLI) can also leverage environment varia
 
 | Variable                | Description       |
 |------------------------ | ----------------- |
-| `APPRISE_URLS`          |  Specify the default URLs to notify IF none are otherwise specified on the command line explicitly. If the `--config` (`-c`) is specified, then this will over-rides any reference to this variable. Use white space and/or a comma (`,`) to delimit multiple entries.
-|  `APPRISE_CONFIG_PATH`  | Explicitly specify the config search path to use (over-riding the default). The path(s) defined here must point to the absolute filename to open/reference. Use a semi-colon (`;`), line-feed (`\n`), and/or carriage return (`\r`) to delimit multiple entries.
-|  `APPRISE_PLUGIN_PATH`  | Explicitly specify the custom plugin search path to use (over-riding the default). Use a semi-colon (`;`), line-feed (`\n`), and/or carriage return (`\r`) to delimit multiple entries.
-|  `APPRISE_STORAGE_PATH` | Explicitly specify the persistent storage path to use (over-riding the default).
+| `APPRISE_URLS`          |  Specify the default URLs to notify IF none are otherwise specified on the command line explicitly. If the `--config` (`-c`) is specified, then this will overrides any reference to this variable. Use white space and/or a comma (`,`) to delimit multiple entries.
+|  `APPRISE_CONFIG_PATH`  | Explicitly specify the config search path to use (overriding the default). The path(s) defined here must point to the absolute filename to open/reference. Use a semi-colon (`;`), line-feed (`\n`), and/or carriage return (`\r`) to delimit multiple entries.
+|  `APPRISE_PLUGIN_PATH`  | Explicitly specify the custom plugin search path to use (overriding the default). Use a semi-colon (`;`), line-feed (`\n`), and/or carriage return (`\r`) to delimit multiple entries.
+|  `APPRISE_STORAGE_PATH` | Explicitly specify the persistent storage path to use (overriding the default).
 
 # Developer API Usage
 
@@ -447,7 +447,7 @@ apobj.notify(
 apobj.notify(
     body='send a notification to our admin group',
     title='Attention Admins',
-    # notify absolutely everything loaded, regardless on wether
+    # notify absolutely everything loaded, regardless on whether
     # it has a tag associated with it or not:
     tag='all',
 )