Add coverage measurement/reporting and GitHub Actions workflow; updat…

…e README.

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

@@ -0,0 +1,35 @@
+name: lint-test-cover-docs
+on:
+  push
+jobs:
+  lint_test_cover_docs:
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        python-version: ['3.7', '3.8', '3.9', '3.10', '3.11']
+    name: "Python ${{ matrix.python-version }}"
+    steps:
+      - uses: actions/checkout@v3
+      - name: Install Python.
+        uses: actions/setup-python@v4
+        with:
+          python-version: ${{ matrix.python-version }}
+          architecture: x64
+      - name: Lint and test module.
+        run: |
+          pip install -U .[lint,test]
+          python -m pylint permutations # Check against linting rules.
+          python -m pytest # Run tests.
+          python src/permutations/permutations.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'
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+          COVERALLS_REPO_TOKEN: ${{ secrets.COVERALLS_REPO_TOKEN }}
+      - name: Test auto-generation of documentation.
+        run: |
+          pip install -U .[docs]
+          cd docs && sphinx-apidoc -f -E --templatedir=_templates -o _source .. && make html && cd ..

README.rst

@@ -4,12 +4,20 @@ permutations
 
 Python library for instantiating and working with permutation collections that provide efficient implementations of all sequence methods (including random-access retrieval by index).
 
-|pypi|
+|pypi| |actions| |coveralls|
 
 .. |pypi| image:: https://badge.fury.io/py/permutations.svg
    :target: https://badge.fury.io/py/permutations
    :alt: PyPI version and link.
 
+.. |actions| image:: https://github.com/lapets/permutations/workflows/lint-test-cover-docs/badge.svg
+   :target: https://github.com/lapets/permutations/actions/workflows/lint-test-cover-docs.yml
+   :alt: GitHub Actions status.
+
+.. |coveralls| image:: https://coveralls.io/repos/github/lapets/permutations/badge.svg?branch=main
+   :target: https://coveralls.io/github/lapets/permutations?branch=main
+   :alt: Coveralls test coverage summary.
+
 Purpose
 -------
 

pyproject.toml

@@ -30,6 +30,9 @@ test = [
 lint = [
     "pylint~=2.17.0"
 ]
+coveralls = [
+    "coveralls~=3.3.1"
+]
 publish = [
     "build~=0.10",
     "twine~=4.0"