Add GitHub Actions build/publish/sign/release workflow and Python 3.12 support.

Author: lapets

.github/workflows/build-publish-sign-release.yml

@@ -0,0 +1,81 @@
+name: build-publish-sign-release
+on:
+  push:
+    tags:
+      - '*'
+jobs:
+  call-workflow-lint-test-cover-docs:
+    name: Call linting/testing workflow.
+    uses: ./.github/workflows/lint-test-cover-docs.yml
+    secrets: inherit
+  build:
+    name: Build package.
+    needs:
+      - call-workflow-lint-test-cover-docs
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - name: Install Python.
+        uses: actions/setup-python@v5
+        with:
+          python-version: 3.12
+          architecture: x64
+      - name: Install pypa/build.
+        run: python -m pip install .[publish]
+      - name: Build a source tarball and a binary wheel.
+        run: python -m build --sdist --wheel .
+      - name: Store the package distributions.
+        uses: actions/upload-artifact@v4
+        with:
+          name: python-package-distributions
+          path: dist/
+  publish:
+    name: Publish package to PyPI.
+    if: startsWith(github.ref, 'refs/tags/') # Publish on tag pushes.
+    needs:
+      - build
+    runs-on: ubuntu-latest
+    environment:
+      name: pypi
+      url: https://pypi.org/p/modulo
+    permissions:
+      id-token: write
+    steps:
+      - name: Download all the package distributions.
+        uses: actions/download-artifact@v4
+        with:
+          name: python-package-distributions
+          path: dist/
+      - name: Publish package to PyPI.
+        uses: pypa/gh-action-pypi-publish@release/v1
+  sign-release:
+    name: Sign package distributions with Sigstore and upload them to a GitHub release.
+    needs:
+      - publish
+    runs-on: ubuntu-latest
+    permissions:
+      contents: write # For GitHub.
+      id-token: write # For Sigstore.
+    steps:
+      - name: Download all the package distributions.
+        uses: actions/download-artifact@v4
+        with:
+          name: python-package-distributions
+          path: dist/
+      - name: Sign the package distributions with Sigstore.
+        uses: sigstore/[email protected]
+        with:
+          inputs: >-
+            ./dist/*.tar.gz
+            ./dist/*.whl
+      - name: Create a GitHub release.
+        env:
+          GITHUB_TOKEN: ${{ github.token }}
+        run: gh release create '${{ github.ref_name }}' --repo '${{ github.repository }}'
+      - name: Upload package distributions and signatures/certificates to the GitHub release.
+        env:
+          GITHUB_TOKEN: ${{ github.token }}
+        run: >-
+          gh release upload
+          '${{ github.ref_name }}' dist/**
+          --repo '${{ github.repository }}'

.github/workflows/lint-test-cover-docs.yml

@@ -1,17 +1,20 @@
 name: lint-test-cover-docs
 on:
-  push
+  push:
+    branches:
+      - '**'
+  workflow_call: # If invoked by build-publish-sign-release workflow.
 jobs:
   lint_test_cover_docs:
-    runs-on: ubuntu-latest
+    runs-on: ubuntu-20.04
     strategy:
       matrix:
-        python-version: ['3.7', '3.8', '3.9', '3.10', '3.11']
-    name: "Python ${{ matrix.python-version }}"
+        python-version: ['3.7', '3.8', '3.9', '3.10', '3.11', '3.12']
+    name: Python ${{ matrix.python-version }}
     steps:
-      - uses: actions/checkout@v3
+      - uses: actions/checkout@v4
       - name: Install Python.
-        uses: actions/setup-python@v4
+        uses: actions/setup-python@v5
         with:
           python-version: ${{ matrix.python-version }}
           architecture: x64
@@ -20,11 +23,12 @@ jobs:
           pip install -U .[lint,test]
           python -m pylint modulo # Check against linting rules.
           python -m pytest # Run tests.
+          python src/modulo/modulo.py -v # Run tests via execution.
       - name: Publish coverage results.
         run: |
           pip install -U .[coveralls]
           python -m coveralls --service=github # Submit to coveralls.
-        if: matrix.python-version == '3.11'
+        if: matrix.python-version == '3.12'
         env:
           GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
           COVERALLS_REPO_TOKEN: ${{ secrets.COVERALLS_REPO_TOKEN }}

README.rst

@@ -6,15 +6,15 @@ Pure-Python library for working with modular arithmetic, congruence classes, and
 
 |pypi| |readthedocs| |actions| |coveralls|
 
-.. |pypi| image:: https://badge.fury.io/py/modulo.svg
+.. |pypi| image:: https://badge.fury.io/py/modulo.svg#
    :target: https://badge.fury.io/py/modulo
    :alt: PyPI version and link.
 
 .. |readthedocs| image:: https://readthedocs.org/projects/modulo-lib/badge/?version=latest
    :target: https://modulo-lib.readthedocs.io/en/latest/?badge=latest
    :alt: Read the Docs documentation status.
 
-.. |actions| image:: https://github.com/lapets/modulo/workflows/lint-test-cover-docs/badge.svg
+.. |actions| image:: https://github.com/lapets/modulo/workflows/lint-test-cover-docs/badge.svg#
    :target: https://github.com/lapets/modulo/actions/workflows/lint-test-cover-docs.yml
    :alt: GitHub Actions status.
 
@@ -34,7 +34,7 @@ This library is available as a `package on PyPI <https://pypi.org/project/modulo
 
     python -m pip install modulo
 
-The library can be imported in the usual way:
+The library can be imported in the usual ways:
 
 .. code-block:: python
 
@@ -157,15 +157,15 @@ All installation and development dependencies are fully specified in ``pyproject
 
 .. code-block:: bash
 
-    python -m pip install .[docs,lint]
+    python -m pip install ".[docs,lint]"
 
 Documentation
 ^^^^^^^^^^^^^
 The documentation can be generated automatically from the source files using `Sphinx <https://www.sphinx-doc.org>`__:
 
 .. code-block:: bash
 
-    python -m pip install .[docs]
+    python -m pip install ".[docs]"
     cd docs
     sphinx-apidoc -f -E --templatedir=_templates -o _source .. && make html
 
@@ -175,7 +175,7 @@ All unit tests are executed and their coverage is measured when using `pytest <h
 
 .. code-block:: bash
 
-    python -m pip install .[test]
+    python -m pip install ".[test]"
     python -m pytest
 
 Alternatively, all unit tests are included in the module itself and can be executed using `doctest <https://docs.python.org/3/library/doctest.html>`__:
@@ -188,7 +188,7 @@ Style conventions are enforced using `Pylint <https://pylint.readthedocs.io>`__:
 
 .. code-block:: bash
 
-    python -m pip install .[lint]
+    python -m pip install ".[lint]"
     python -m pylint src/modulo
 
 Contributions
@@ -201,28 +201,13 @@ Beginning with version 0.2.0, the version number format for this library and the
 
 Publishing
 ^^^^^^^^^^
-This library can be published as a `package on PyPI <https://pypi.org/project/modulo>`__ by a package maintainer. First, install the dependencies required for packaging and publishing:
+This library can be published as a `package on PyPI <https://pypi.org/project/modulo>`__ via the GitHub Actions workflow found in ``.github/workflows/build-publish-sign-release.yml`` that follows the `recommendations found in the Python Packaging User Guide <https://packaging.python.org/en/latest/guides/publishing-package-distribution-releases-using-github-actions-ci-cd-workflows/>`__.
 
-.. code-block:: bash
-
-    python -m pip install .[publish]
+Ensure that the correct version number appears in ``pyproject.toml``, and that any links in this README document to the Read the Docs documentation of this package (or its dependencies) have appropriate version numbers. Also ensure that the Read the Docs project for this library has an `automation rule <https://docs.readthedocs.io/en/stable/automation-rules.html>`__ that activates and sets as the default all tagged versions.
 
-Ensure that the correct version number appears in ``pyproject.toml``, and that any links in this README document to the Read the Docs documentation of this package (or its dependencies) have appropriate version numbers. Also ensure that the Read the Docs project for this library has an `automation rule <https://docs.readthedocs.io/en/stable/automation-rules.html>`__ that activates and sets as the default all tagged versions. Create and push a tag for this version (replacing ``?.?.?`` with the version number):
+To publish the package, create and push a tag for the version being published (replacing ``?.?.?`` with the version number):
 
 .. code-block:: bash
 
     git tag ?.?.?
     git push origin ?.?.?
-
-Remove any old build/distribution files. Then, package the source into a distribution archive:
-
-.. code-block:: bash
-
-    rm -rf build dist src/*.egg-info
-    python -m build --sdist --wheel .
-
-Finally, upload the package distribution archive to `PyPI <https://pypi.org>`__:
-
-.. code-block:: bash
-
-    python -m twine upload dist/*

pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "modulo"
-version = "2.1.0"
+version = "3.0.0"
 description = """\
     Pure-Python library for working with modular arithmetic, \
     congruence classes, and finite fields.\
@@ -13,7 +13,7 @@ authors = [
 readme = "README.rst"
 requires-python = ">=3.7"
 dependencies = [
-    "egcd~=0.5"
+    "egcd~=1.0"
 ]
 
 [project.urls]
@@ -23,18 +23,21 @@ Documentation = "https://modulo-lib.readthedocs.io"
 [project.optional-dependencies]
 docs = [
     "toml~=0.10.2",
-    "sphinx~=4.2.0",
-    "sphinx-rtd-theme~=1.0.0"
+    "sphinx~=5.0",
+    "sphinx-rtd-theme~=2.0.0"
 ]
 test = [
-    "pytest~=7.2",
-    "pytest-cov~=4.0"
+    "pytest~=7.4; python_version < '3.12'",
+    "pytest~=8.2; python_version >= '3.12'",
+    "pytest-cov~=4.1; python_version < '3.12'",
+    "pytest-cov~=5.0; python_version >= '3.12'"
 ]
 lint = [
-    "pylint~=2.17.0"
+    "pylint~=2.17.0; python_version < '3.12'",
+    "pylint~=3.2.0; python_version >= '3.12'"
 ]
 coveralls = [
-    "coveralls~=3.3.1"
+    "coveralls~=4.0"
 ]
 publish = [
     "build~=0.10",
@@ -43,7 +46,7 @@ publish = [
 
 [build-system]
 requires = [
-    "setuptools~=67.6"
+    "setuptools>=68.0"
 ]
 build-backend = "setuptools.build_meta"
 

src/modulo/__init__.py

@@ -1,2 +1,2 @@
-"""Gives users direct access to class and synonyms."""
+"""Allow users to access the class and synonyms directly."""
 from modulo.modulo import modulo, mod, Z