.coveragerc

@@ -1,6 +1,17 @@
 [report]
+show_missing = true
+skip_covered = true
+skip_empty = true
+
+[run]
+# Ensure all python modules in hab have their coverage reported,
+# not just files that pytest touches.
+source = hab
 omit =
     */site-packages/*
     */.tox/*
     tests/*
-show_missing = true
+    # This file is automatically generated by setuptools_scm
+    hab/version.py
+parallel=True
+relative_files=True

.github/workflows/python-release.yml

@@ -11,23 +11,33 @@ jobs:
 
     steps:
       - name: Checkout code
-        uses: actions/checkout@v2
+        uses: actions/checkout@v4
         with:
           fetch-depth: 0
 
       - name: Setup Python
-        uses: actions/setup-python@v2
+        uses: actions/setup-python@v5
         with:
           python-version: "3.x"
 
       - name: Install dependencies
         run: |
           python -m pip install --upgrade pip
-          python -m pip install --upgrade setuptools wheel twine
+          python -m pip install --upgrade build setuptools wheel twine
 
       - name: Build wheel
         run: |
-          python setup.py build bdist_wheel
+          python -m build --wheel --sdist
+
+      # Upload the built pip packages so we can inspect them
+      - name: Upload packages.
+        uses: actions/upload-artifact@v3
+        with:
+          name: pip-packages
+          path: |
+            dist/hab-*.whl
+            dist/hab-*.tar.gz
+          retention-days: 1
 
       - name: Publish to PyPI
         env:

.github/workflows/python-static-analysis-and-test.yml

@@ -17,17 +17,19 @@ jobs:
 
     steps:
       - name: Checkout code
-        uses: actions/checkout@v2
+        uses: actions/checkout@v4
 
       - name: Setup Python
-        uses: actions/setup-python@v2
+        uses: actions/setup-python@v5
         with:
-          python-version: "3.x"
+          # NOTE: Currently running this with python 3.12 causes
+          # flake8 false-positives on lines with f-strings E226,E231,E241,E702
+          python-version: "3.11"
 
       - name: Install dependencies
         run: |
           python -m pip install --upgrade pip
-          python -m pip install tox
+          python -m pip install tox coverage[toml]
 
       - name: Lint with flake8
         run: tox -e flake8
@@ -44,18 +46,33 @@ jobs:
       github.event_name == 'push' ||
       github.event.pull_request.head.repo.full_name != github.repository
 
-    runs-on: ubuntu-latest
-
     strategy:
       matrix:
-        python: ['3.6', '3.7', '3.8', '3.9', '3.10']
+        # Test if using native json or pyjson5 for json parsing
+        pkg_mods: ['json', 'json5', 's3']
+        os: ['ubuntu-latest', 'windows-latest']
+        python: ['3.8', '3.9', '3.10', '3.11']
+        # Works around the depreciation of python 3.6 for ubuntu
+        # https://github.com/actions/setup-python/issues/544
+        include:
+          - pkg_mods: 'json'
+            os: 'ubuntu-22.04'
+            python: '3.7'
+          - pkg_mods: 'json5'
+            os: 'ubuntu-22.04'
+            python: '3.7'
+          - pkg_mods: 's3'
+            os: 'ubuntu-22.04'
+            python: '3.7'
+
+    runs-on: ${{ matrix.os }}
 
     steps:
       - name: Checkout code
-        uses: actions/checkout@v2
+        uses: actions/checkout@v4
 
       - name: Setup Python
-        uses: actions/setup-python@v2
+        uses: actions/setup-python@v5
         with:
           python-version: ${{ matrix.python }}
 
@@ -66,37 +83,113 @@ jobs:
 
       - name: Run Tox
         run: |
-          tox -e py
+          tox -e begin,py-${{ matrix.pkg_mods }}
 
+      - name: Upload coverage
+        uses: actions/upload-artifact@v4
+        with:
+          name: coverage-${{ matrix.os }}-${{ matrix.python }}-${{ matrix.pkg_mods }}
+          path: .coverage.*
+          include-hidden-files: true
+          retention-days: 1
 
-  test-json5:
+  coverage:
     # We want to run on external PRs, but not on our own internal PRs as they'll
     # be run by the push to the branch. Without this if check, checks are
     # duplicated since internal PRs match both the push and pull_request events.
     if:
       github.event_name == 'push' ||
       github.event.pull_request.head.repo.full_name != github.repository
 
+    needs: test
+
     runs-on: ubuntu-latest
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v4
 
-    strategy:
-      matrix:
-        python: ['3.7', '3.8', '3.9', '3.10']
+      - name: Setup Python
+        uses: actions/setup-python@v5
+        with:
+          python-version: "3.x"
+
+      - name: Install dependencies
+        run: |
+          python -m pip install --upgrade pip
+          python -m pip install tox coverage[toml]
+
+      # Ensure version.py is created so coverage can read it's source
+      - name: Run begin
+        run: |
+          tox -e begin
+
+      - name: Download coverage artifacts
+        uses: actions/download-artifact@v4
+        with:
+          pattern: coverage-*
+          merge-multiple: true
+
+      # Tox runs `coverage combine` and `coverage xml`
+      - name: Combine coverage and report
+        run: |
+          tox -e end
+
+          # Report and write to summary.
+          python -m coverage report --format=markdown >> $GITHUB_STEP_SUMMARY
+
+          # Write html coverage report to upload as an artifact
+          python -m coverage html
+
+          # # Report again and fail if under 100%.
+          # python -m coverage report --fail-under=100
+
+      - name: Upload HTML report if check failed.
+        uses: actions/upload-artifact@v4
+        with:
+          name: html-report
+          path: htmlcov
+          # # TODO: If we get 100% coverage we can re-enable this and the
+          # # `--fail-under` check so pull requests fail if the dev doesn't
+          # # add tests for new code.
+          # if: ${{ failure() }}
+
+
+  pip-package:
+    # We want to run on external PRs, but not on our own internal PRs as they'll
+    # be run by the push to the branch. Without this if check, checks are
+    # duplicated since internal PRs match both the push and pull_request events.
+    if:
+      github.event_name == 'push' ||
+      github.event.pull_request.head.repo.full_name != github.repository
+
+    # Build and upload pip packages as artifacts so we can inspect them and
+    # ensure they are correct for actual release
+    runs-on: ubuntu-latest
 
     steps:
       - name: Checkout code
-        uses: actions/checkout@v2
+        uses: actions/checkout@v4
+        with:
+          fetch-depth: 0
 
       - name: Setup Python
-        uses: actions/setup-python@v2
+        uses: actions/setup-python@v5
         with:
-          python-version: ${{ matrix.python }}
+          python-version: "3.x"
 
       - name: Install dependencies
         run: |
           python -m pip install --upgrade pip
-          python -m pip install tox
+          python -m pip install --upgrade build setuptools wheel twine
 
-      - name: Run Tox
+      - name: Build wheel
         run: |
-          tox -e py-json5
+          python -m build --wheel --sdist
+
+      - name: Upload packages.
+        uses: actions/upload-artifact@v4
+        with:
+          name: pip-packages
+          path: |
+            dist/hab-*.whl
+            dist/hab-*.tar.gz

.gitignore

@@ -2,15 +2,21 @@
 *.pyc
 *.swp
 .coverage
+.coverage.*
 .DS_Store
 .eggs
 .pytest_cache
 .tox/
 __pycache__/
 build/
+coverage.xml
 dist/
+docs/
 htmlcov/
 venv/
+.venv/
 version.py
 *.sublime-project
 *.sublime-workspace
+*.code-workspace
+.vscode/

.pre-commit-config.yaml

@@ -1,8 +1,12 @@
 ---
+ci:
+  autoupdate_schedule: quarterly
+  skip: [black, flake8, setup-cfg-fmt]
+
 repos:
 
 -   repo: https://github.com/psf/black
-    rev: 22.6.0
+    rev: 22.12.0
     hooks:
     -   id: black
 
@@ -11,16 +15,17 @@ repos:
     hooks:
     -   id: flake8
         additional_dependencies:
-            - flake8-bugbear==22.4.25
-            - pep8-naming==0.13.0
+            - flake8-bugbear==22.12.6
+            - pep8-naming==0.13.3
 
 -   repo: https://github.com/asottile/setup-cfg-fmt
-    rev: v2.0.0
+    rev: v2.5.0
     hooks:
     -   id: setup-cfg-fmt
+        args: [--min-py3-version=3.7]
 
 -   repo: https://github.com/pre-commit/pre-commit-hooks
-    rev: v4.3.0
+    rev: v4.6.0
     hooks:
       - id: check-json
         exclude: '^tests/invalid.json'
@@ -33,7 +38,7 @@ repos:
       - id: trailing-whitespace
 
 -   repo: https://github.com/pycqa/isort
-    rev: 5.10.1
+    rev: 5.13.2
     hooks:
       - id: isort
         name: isort (python)

CONTRIBUTING.md

@@ -67,7 +67,7 @@ Code formatting is completed by [black]. By relinquishing code appearance standa
 
 Releases are made manually by project managers and will automatically be uploaded to PyPI (via GitHib Action workflow) once completed.
 
-[flake8]: https://gitlab.com/pycqa/flake8
+[flake8]: https://github.com/PyCQA/flake8
 [flake8-bugbear]: https://github.com/PyCQA/flake8-bugbear
 [pep8-naming]: https://github.com/PyCQA/pep8-naming
 [setup.cfg]: https://github.com/blurstudio/python-example/blob/master/setup.cfg