Use setuptools for plugin mechanism. (#72)

* Convert to pyproject.toml configuration.
* Drop Python 3.8.
* Add Python 3.13.
* Add ubuntu-24.04 to CI.
* Remove proselint plugin. Not used as far as I know, and causing too many issues with type hints and unit tests.
* Be explicit that we are ignoring unit test line coverage for now.
* Use runner.os to simplify Linux-specific action steps.

Author: tdenewiler

.codecov.yml

@@ -0,0 +1,6 @@
+coverage:
+  status:
+    project:
+      default:
+        target: 0%
+        threshold: null

.github/workflows/publish.yaml

@@ -1,7 +1,7 @@
 ---
 name: Publish Python 🐍 distributions 📦 to PyPI and TestPyPI
 
-on: # NOLINT
+on:  # NOLINT
   push:
     tags:
       - "*"
@@ -10,6 +10,11 @@ jobs:
   build-n-publish:
     name: Build and publish Python 🐍 distributions 📦 to PyPI and TestPyPI
     runs-on: ubuntu-latest
+    environment:
+      name: pypi
+      url: https://pypi.org/p/statick-md
+    permissions:
+      id-token: write
 
     steps:
       - uses: actions/checkout@v3
@@ -18,47 +23,16 @@ jobs:
         uses: actions/setup-python@v4
         with:
           python-version: "3.11"
-
-      - uses: actions/cache@v3
-        if: startsWith(runner.os, 'Linux')
-        with:
-          path: ~/.cache/pip
-          key: ${{ runner.os }}-pip-${{ hashFiles('**/requirements.txt') }}
-          restore-keys: |
-            ${{ runner.os }}-pip-
-
-      - uses: actions/cache@v3
-        if: startsWith(runner.os, 'macOS')
-        with:
-          path: ~/Library/Caches/pip
-          key: ${{ runner.os }}-pip-${{ hashFiles('**/requirements.txt') }}
-          restore-keys: |
-            ${{ runner.os }}-pip-
-
-      - uses: actions/cache@v3
-        if: startsWith(runner.os, 'Windows')
-        with:
-          path: ~\AppData\Local\pip\Cache
-          key: ${{ runner.os }}-pip-${{ hashFiles('**/requirements.txt') }}
-          restore-keys: |
-            ${{ runner.os }}-pip-
+          cache: 'pip'
 
       - name: Install tools
         run: |
-          python -m pip install --upgrade setuptools
-          python -m pip install --upgrade wheel
+          pip install .[dist]
 
       - name: Build a binary wheel and a source tarball
         run: |
-          python setup.py sdist bdist_wheel
-
-      - name: Publish distribution 📦 to Test PyPI
-        uses: pypa/gh-action-pypi-publish@release/v1
-        with:
-          password: ${{ secrets.PYPI_TEST_TOKEN }}
-          repository_url: https://test.pypi.org/legacy/
+          pip install -q build
+          python -m build
 
       - name: Publish distribution 📦 to PyPI
         uses: pypa/gh-action-pypi-publish@release/v1
-        with:
-          password: ${{ secrets.PYPI_TOKEN }}

.github/workflows/tests.yaml

@@ -14,86 +14,55 @@ jobs:
     runs-on: ${{ matrix.os }}
     strategy:
       matrix:
-        os: [macos-latest, ubuntu-20.04, ubuntu-22.04, windows-latest]
-        python-version: ['3.8', '3.9', '3.10', '3.11']
+        os: [macos-latest, ubuntu-20.04, ubuntu-22.04, ubuntu-24.04, windows-latest]
+        python-version: ['3.9', '3.10', '3.11', '3.12', '3.13']
 
     steps:
-      - uses: actions/checkout@v3
+      - uses: actions/checkout@v4
 
-      - uses: actions/setup-node@v3
+      - uses: actions/setup-node@v4
         with:
-          node-version: '16'
+          node-version: '20'
 
       - name: Set up Python ${{ matrix.python-version }}
-        uses: actions/setup-python@v4
+        uses: actions/setup-python@v5
         with:
           python-version: ${{ matrix.python-version }}
-
-      - uses: actions/cache@v3
-        if: startsWith(runner.os, 'Linux')
-        with:
-          path: ~/.cache/pip
-          key: ${{ runner.os }}-pip-${{ hashFiles('**/requirements.txt') }}
-          restore-keys: |
-            ${{ runner.os }}-pip-
-
-      - uses: actions/cache@v3
-        if: startsWith(runner.os, 'macOS')
-        with:
-          path: ~/Library/Caches/pip
-          key: ${{ runner.os }}-pip-${{ hashFiles('**/requirements.txt') }}
-          restore-keys: |
-            ${{ runner.os }}-pip-
-
-      - uses: actions/cache@v3
-        if: startsWith(runner.os, 'Windows')
-        with:
-          path: ~\AppData\Local\pip\Cache
-          key: ${{ runner.os }}-pip-${{ hashFiles('**/requirements.txt') }}
-          restore-keys: |
-            ${{ runner.os }}-pip-
+          cache: 'pip'
 
       - name: Install dependencies
         run: |
           python -m pip install --upgrade pip
-          python -m pip install --upgrade setuptools
-          python -m pip install --upgrade wheel
-          python -m pip install --upgrade coverage
-          python -m pip install --upgrade mypy
-          python -m pip install --upgrade types-docutils
-          python -m pip install --upgrade tox
-          python -m pip install --upgrade tox-gh-actions
-          python -m pip install --upgrade virtualenv
+          pip install .[docs,test]
 
-      # Have to install newer version from non-apt source due to SSL library compatibility issues.
-      - name: Install Node and node-based tools (Linux)
-        if: matrix.os == 'ubuntu-20.04' || matrix.os == 'ubuntu-22.04'
+      - name: Install Node tools (Linux)
+        if: runner.os == 'Linux'
         run: |
           npm install -g markdownlint-cli
           npm install -g write-good
 
       - name: Mypy
         run: |
-          mypy --ignore-missing-imports --strict src/
+          mypy --ignore-missing-imports --strict src/statick_tool/
 
       - name: Tox
         run: |
           python -m tox
 
       - name: Upload coverage to Codecov
-        uses: codecov/codecov-action@v3
+        uses: codecov/codecov-action@v5
         with:
           fail_ci_if_error: false
 
       - name: Statick Documentation
-        if: matrix.os == 'ubuntu-20.04' || matrix.os == 'ubuntu-22.04'
+        if: runner.os == 'Linux'
         uses: sscpac/statick-action@v0.9.2
         with:
           profile: documentation.yaml
           timings: true
 
       - name: Self check
-        if: matrix.os == 'ubuntu-20.04' || matrix.os == 'ubuntu-22.04'
+        if: runner.os == 'Linux'
         uses: sscpac/statick-action@v0.9.2
         with:
           profile: self_check.yaml

CHANGELOG.md

@@ -6,6 +6,28 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/)
 
 ## Unreleased
 
+### Added
+
+- Support for Python 3.12 and 3.13.
+- Use of `pyproject.toml` instead of `setup.py` and `requirements.txt`.
+- Supports new plugin discovery mechanism for the main Statick tool.
+  - Switched from yapsy to setuptools for plugin mechanism. (sscpac/statick#508)
+
+### Changed
+
+- Disabled code coverage requirements in CI for now.
+  - Unable to get line coverage working with new plugin mechanism.
+    Unit tests still work to find problems.
+- Updated README to use more modern approach to installing Python and NPM packages.
+- Rename plugin modules so they are shorter and less redundant.
+
+### Removed
+
+- No longer support Python 3.8.
+- Proselint tool removed.
+  - Unable to resolve type hint and unit test issues.
+    Tool not used as far as Statick developers are aware.
+
 ## v0.2.0 - 2025-01-03
 
 ### Removed

README.md

@@ -18,38 +18,61 @@ Custom exceptions can be applied the same way they are with
 
 ## Table of Contents
 
-* [Installation](#installation)
-* [Usage](#usage)
-* [Existing Plugins](#existing-plugins)
-  * [Discovery Plugins](#discovery-plugins)
-  * [Tool Plugins](#tool-plugins)
-* [Contributing](#contributing)
-  * [Mypy](#mypy)
-  * [Formatting](#formatting)
+- [Statick Markdown Plugins](#statick-markdown-plugins)
+  - [Table of Contents](#table-of-contents)
+  - [Installation](#installation)
+  - [Usage](#usage)
+    - [Dependency Versions](#dependency-versions)
+    - [Pip Install](#pip-install)
+    - [Pip Install and Custom Configuration](#pip-install-and-custom-configuration)
+  - [Existing Plugins](#existing-plugins)
+    - [Discovery Plugins](#discovery-plugins)
+    - [Tool Plugins](#tool-plugins)
+  - [Contributing](#contributing)
+    - [Mypy](#mypy)
+    - [Formatting](#formatting)
 
 ## Installation
 
 The recommended method to install these Statick plugins is via pip:
 
 ```shell
-python3 -m pip install statick-md
+pip install statick-md
 ```
 
 You can also clone the repository and use it locally.
 
 ## Usage
 
-Make sure you install all the dependencies from apt/npm:
+Make sure you install all the dependencies from apt/npm.
+See <https://github.com/nodesource/distributions> for Node/npm installation instructions.
+
+Configure npm to allow a non-root user to install packages.
+
+```shell
+npm config set prefix '~/.local/'
+```
+
+Make sure `~/.local/bin` exists.
+Check your `PATH` with `echo $PATH`.
+If `~/.local/bin` is not listed then add it to your `PATH`.
 
 ```shell
-cat install.txt | xargs sudo apt-get install -y
-cat npm-deps.txt | xargs sudo npm install -g
+mkdir -p ~/.local/bin
+echo 'export PATH="$HOME/.local/bin/:$PATH"' >> ~/.bashrc
+```
+
+Install packages.
+
+```shell
+npm install -g markdownlint-cli
+npm install -g write-good
 ```
 
 ### Dependency Versions
 
 Markdownlint-cli has occasionally changed defaults via an upgrade that results in lots of new warnings.
-To mitigate this you can pin the version of markdownlint-cli in npm-deps.txt by changing `markdownlint-cli` to `markdownlint-cli@0.19`.
+To mitigate this you can pin the version of markdownlint-cli when installing by changing `markdownlint-cli` to `markdownlint-cli@0.19`.
 
 ### Pip Install
 
@@ -59,13 +82,12 @@ In that case your directory structure will look like the following:
 ```shell
 project-root
  |- md-project
- |- statick-output
 ```
 
 To run with the default configuration for the statick-md tools use:
 
 ```shell
-statick md-project/ --output-directory statick-output/ --profile md-profile.yaml --config md-config.yaml
+statick md-project/ -o /tmp/statick-output/ --level md --log info
 ```
 
 ### Pip Install and Custom Configuration
@@ -77,40 +99,16 @@ This example will have custom exceptions in the md-project, such that the direct
 
 ```shell
 project-root
- |- md-project
- |- statick-config
-     |- rsc
-         |- exceptions.yaml
- |- statick-output
+|- md-project
+    |- statick-config
+        |- rsc
+            |- exceptions.yaml
 ```
 
 For this setup you will run the following:
 
 ```shell
-statick md-project/ --output-directory statick-output/ --user-paths md-project/statick-config/ --profile md-profile.yaml --config md-config.yaml
-```
-
-### Source Install and Custom Configuration
-
-The last type of setup will be to have all of the tools available from cloning repositories, not installing from pip.
-The directory structure will look like:
-
-```shell
-project-root
- |- md-project
- |- statick-config
-     |- rsc
-         |- exceptions.yaml
- |- statick-output
- |- statick
- |- statick-md
-```
-
-Using the example where we want to override the default exceptions with
-custom ones in the md-project, the command to run would be:
-
-```shell
-./statick/statick md-project/ --output-directory statick-output/ --user-paths statick-md/,statick-md/src/statick_md,md-project/statick-config/ --profile md-profile.yaml --config md-config.yaml
+statick md-project/ --o /tmp/statick-output/ -u md-project/statick-config/ --level md
 ```
 
 ## Existing Plugins
@@ -127,7 +125,6 @@ reStructuredText | `.rst`
 Tool | About
 :--- | :----
 [markdownlint][markdownlint] | A Node.js style checker and lint tool for Markdown/CommonMark files.
-[proselint][proselint]       | A linter for prose.
 [rstcheck][rstcheck]         | Checks syntax of reStructuredText and code blocks nested within it.
 [rst-lint][rst-lint]         | Checks syntax of reStructuredText and code blocks nested within it.
 [write-good]                 | Naive linter for English prose.
@@ -150,25 +147,22 @@ To determine if proper types are being used in Statick Markdown the following co
 types of reports that can be viewed with a text editor or web browser.
 
 ```shell
-python3 -m pip install mypy
+pip install mypy
 mkdir report
-mypy --ignore-missing-imports --strict --html-report report/ --txt-report report src
+mypy --ignore-missing-imports --strict src
 ```
 
-It is hoped that in the future we will generate coverage reports from mypy and use those to check for regressions.
-
 ### Formatting
 
 Statick code is formatted using [black](https://github.com/psf/black).
 To fix locally use
 
 ```shell
-python3 -m pip install black
+pip install black
 black src tests
 ```
 
 [markdownlint]: https://github.com/igorshubovych/markdownlint-cli
-[proselint]: https://github.com/amperser/proselint
 [rstcheck]: https://github.com/myint/rstcheck
 [rst-lint]: https://github.com/twolfson/restructuredtext-lint
 [write-good]: https://github.com/btford/write-good

clean.sh

@@ -1,5 +1,5 @@
 #!/bin/bash
 
-rm -rf build/ dist/ output-py* .pytest_cache statick_md.egg-info/ statick_output/* .tox/
+rm -rf build/ .coverage dist/ output-py* .pytest_cache statick_md.egg-info/ statick_output/* .tox/ ./*.log
 find . -type d -name .mypy_cache -exec rm -rf {} +;
 find . -type d -name __pycache__ -exec rm -rf {} +;