Updates from code review.

gilesknap · gilesknap · commit 15fd2f4c9ba3 · 2022-08-26T10:49:11.000+01:00
updates from review

system python for lint

better release files

final review changes

add test of runtime container
diff --git a/.containerignore b/.containerignore
@@ -4,3 +4,4 @@ dist/
 .mypy_cache
 .tox
 .venv*
+venv*
diff --git a/.devcontainer.json b/.devcontainer.json
@@ -12,7 +12,7 @@
     },
     // Set *default* container specific settings.json values on container create.
     "settings": {
-        "python.defaultInterpreterPath": "/usr/local/bin/python",
+        "python.defaultInterpreterPath": "/venv/bin/python",
         "python.linting.enabled": true
     },
     // Add the IDs of extensions you want installed when the container is created.
@@ -21,12 +21,10 @@
         "ms-python.vscode-pylance"
     ],
     // Make sure the files we are mapping into the container exist on the host
-    "initializeCommand": "bash -c 'for i in $HOME/.inputrc $HOME/.bashrc_dev; do [ -f $i ] || touch $i; done'",
+    "initializeCommand": "bash -c 'for i in $HOME/.inputrc; do [ -f $i ] || touch $i; done'",
     "runArgs": [
-        "--privileged",
         "--net=host",
         "-v=${localEnv:HOME}/.ssh:/root/.ssh",
-        "-v=${localEnv:HOME}/.bashrc_dev:/root/.bashrc",
         "-v=${localEnv:HOME}/.inputrc:/root/.inputrc"
     ],
     "mounts": [
diff --git a/.gitattributes b/.gitattributes
diff --git a/.github/workflows/code.yml b/.github/workflows/code.yml
@@ -5,7 +5,7 @@ on:
   pull_request:
   schedule:
     # Run every Monday at 8am to check latest versions of dependencies
-    - cron: "0 8 * * MON"
+    - cron: "0 8 * * WED"
 
 jobs:
   lint:
@@ -17,15 +17,15 @@ jobs:
       - name: Checkout
         uses: actions/checkout@v2
 
-      - uses: actions/setup-python@v4
+      - name: Setup python
+        uses: actions/setup-python@v4
         with:
           python-version: "3.10"
 
       - name: Lint
         run: |
-          touch requirements_dev.txt
-          python -m pip install --upgrade pip
-          python -m pip install -r requirements_dev.txt -e .[dev]
+          touch requirements_dev.txt requirements.txt
+          pip install -r requirements.txt -r requirements_dev.txt -e .[dev]
           tox -e pre-commit,mypy
 
   test:
@@ -59,7 +59,7 @@ jobs:
         run: pytest tests
 
       - name: Upload coverage to Codecov
-        uses: codecov/codecov-action@v2
+        uses: codecov/codecov-action@v3
         with:
           name: ${{ matrix.python }}/${{ matrix.os }}
           files: cov.xml
@@ -77,14 +77,6 @@ jobs:
         with:
           fetch-depth: 0
 
-      - name: Cache Docker layers
-        uses: actions/cache@v3
-        with:
-          path: /tmp/.buildx-cache
-          key: ${{ runner.os }}-buildx-${{ github.sha }}
-          restore-keys: |
-            ${{ runner.os }}-buildx-
-
       - name: Log in to GitHub Docker Registry
         if: github.event_name != 'pull_request'
         uses: docker/login-action@v2
@@ -112,16 +104,21 @@ jobs:
           tags: build:latest
           context: .
           target: build
-          cache-from: type=local,src=/tmp/.buildx-cache
-          cache-to: type=local,dest=/tmp/.buildx-cache
           load: true
 
       - name: Run tests in the container locked with requirements_dev.txt
         run: |
-          docker run --name test build bash /project/tests/container_tests.sh
+          docker run --name test build bash /project/.github/workflows/container_tests.sh
           docker cp test:/project/dist .
           docker cp test:/project/requirements.txt .
           docker cp test:/project/requirements_dev.txt .
+          docker cp test:/project/cov.xml .
+
+      - name: Upload coverage to Codecov
+        uses: codecov/codecov-action@v3
+        with:
+          name: 3.10-locked/ubuntu-latest
+          files: cov.xml
 
       - name: Build runtime image
         uses: docker/build-push-action@v3
@@ -130,8 +127,9 @@ jobs:
           tags: ${{ steps.meta.outputs.tags }}
           context: .
           labels: ${{ steps.meta.outputs.labels }}
-          cache-from: type=local,src=/tmp/.buildx-cache
-          cache-to: type=local,dest=/tmp/.buildx-cache
+
+      - name: Check runtime
+        run: for i in ${{ steps.meta.outputs.tags }}; do docker run ${i} --version; done
 
       - name: Upload build files
         uses: actions/upload-artifact@v3
@@ -147,27 +145,19 @@ jobs:
     runs-on: ubuntu-latest
 
     steps:
-      - name: Checkout
-        uses: actions/checkout@v2
-
-      - uses: actions/setup-python@v4
-        with:
-          python-version: "3.10"
-
       - uses: actions/download-artifact@v3
 
       - name: Install sdist in a venv and check cli works
         # ${GITHUB_REPOSITORY##*/} is the repo name without org
         # Replace this with the cli command if different to the repo name
         run: |
-          python -m pip install --upgrade pip
-          python -m pip install build_files/dist/*.gz
+          pip install build_files/dist/*.gz
           ${GITHUB_REPOSITORY##*/} --version
 
   release:
     # upload to PyPI and make a release on every tag
     if: github.event_name == 'push' && startsWith(github.ref, 'refs/tags')
-    needs: [lint, container]
+    needs: container
     runs-on: ubuntu-latest
 
     steps:
@@ -180,6 +170,7 @@ jobs:
         with:
           files: |
             build_files/*
+            build_files/dist/*
           generate_release_notes: true
         env:
           GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
@@ -188,4 +179,4 @@ jobs:
         env:
           TWINE_USERNAME: __token__
           TWINE_PASSWORD: ${{ secrets.pypi_token }}
-        run: pipx run twine upload artifacts/dist/*
+        run: pipx run twine upload build_files/dist/*
diff --git a/.github/workflows/container_tests.sh b/.github/workflows/container_tests.sh
diff --git a/.github/workflows/docs.yml b/.github/workflows/docs.yml
@@ -44,7 +44,7 @@ jobs:
         run: tox -e docs
 
       - name: Move to versioned directory
-        # e.g. master or 0.1.2
+        # e.g. main or 0.1.2
         run: mv build/html ".github/pages/${GITHUB_REF##*/}"
 
       - name: Write versions.txt
diff --git a/.github/workflows/linkcheck.yml b/.github/workflows/linkcheck.yml
@@ -3,7 +3,7 @@ name: Link Check
 on:
   schedule:
     # Run every Monday at 8am to check URL links still resolve
-    - cron: "0 8 * * MON"
+    - cron: "0 8 * * WED"
 
 jobs:
   docs:
@@ -16,10 +16,6 @@ jobs:
     runs-on: ubuntu-latest
 
     steps:
-      - name: Avoid git conflicts when tag and branch pushed at same time
-        if: startsWith(github.ref, 'refs/tags')
-        run: sleep 60
-
       - name: Checkout
         uses: actions/checkout@v2
         with:
diff --git a/.gitignore b/.gitignore
@@ -60,10 +60,8 @@ docs/_build/
 # PyBuilder
 target/
 
-# DLS build dir and virtual environment
-/prefix/
-/venv/
-/lightweight-venv/
-/installed.files
+# likely venv names
 .venv*
+venv*
+
 
diff --git a/.gitremotes b/.gitremotes
diff --git a/.vscode/tasks.json b/.vscode/tasks.json
@@ -5,8 +5,8 @@
     "tasks": [
         {
             "type": "shell",
-            "label": "Tests with coverage",
-            "command": "tox -e pytest",
+            "label": "Tests, lint and docs",
+            "command": "tox -p",
             "options": {
                 "cwd": "${workspaceRoot}"
             },
diff --git a/CONTRIBUTING.rst b/CONTRIBUTING.rst
@@ -61,7 +61,7 @@ The code in this repository conforms to standards set by the following tools:
 - isort_ for import ordering
 - mypy_ for static type checking
 
-flake8 and black be run by pre-commit_. You can run the above checks on
+flake8 and black and isort are run by pre-commit_. You can run the above checks on
 all files with this command::
 
     $ tox -e pre-commit,mypy
@@ -125,7 +125,7 @@ Release Process
 
 To make a new release, please follow this checklist:
 
-- Choose a new PEP440 compliant release number
+- Choose a new PEP440 compliant release number (see https://peps.python.org/pep-0440/)
 - Go to the GitHub release_ page
 - Choose ``Draft New Release``
 - Click ``Choose Tag`` and supply the new tag you chose (click create new tag)
diff --git a/Dockerfile b/Dockerfile
@@ -31,6 +31,7 @@ RUN cd /project && \
     pip install --upgrade pip && \
     pip install -r requirements.txt dist/*.whl && \
     pip freeze  > requirements.txt && \
+    # we don't want to include our own wheel in requirements - remove with sed
     sed -i '/file:\/\//d' requirements.txt
 
 FROM python:3.10-slim as runtime
diff --git a/README.rst b/README.rst
@@ -9,8 +9,6 @@ python3-pip-skeleton
     adopt this skeleton project see 
     https://epics-containers.github.io/python3-pip-skeleton-cli
 
-    [Remove this note when adopting skeleton.]
-
 This is where you should write a short paragraph that describes what your module does,
 how it does it, and why people should use it.
 
diff --git a/docs/explanations.rst b/docs/explanations.rst
@@ -8,4 +8,4 @@ Explanation of how the library works and why it works that way.
 .. toctree::
     :caption: Explanations
 
-    explanations/why-is-something-so
+    explanations/decisions
diff --git a/docs/explanations/decisions.rst b/docs/explanations/decisions.rst
@@ -0,0 +1,17 @@
+.. This Source Code Form is subject to the terms of the Mozilla Public
+.. License, v. 2.0. If a copy of the MPL was not distributed with this
+.. file, You can obtain one at http://mozilla.org/MPL/2.0/.
+
+Architectural Decision Records
+==============================
+
+We record major architectural decisions in Architecture Decision Records (ADRs),
+as `described by Michael Nygard
+<http://thinkrelevance.com/blog/2011/11/15/documenting-architecture-decisions>`_.
+Below is the list of our current ADRs.
+
+.. toctree::
+    :maxdepth: 1
+    :glob:
+
+    decisions/*
diff --git a/docs/explanations/decisions/0001-record-architecture-decisions.rst b/docs/explanations/decisions/0001-record-architecture-decisions.rst
@@ -0,0 +1,26 @@
+1. Record architecture decisions
+================================
+
+Date: 2022-02-18
+
+Status
+------
+
+Accepted
+
+Context
+-------
+
+We need to record the architectural decisions made on this project.
+
+Decision
+--------
+
+We will use Architecture Decision Records, as `described by Michael Nygard
+<http://thinkrelevance.com/blog/2011/11/15/documenting-architecture-decisions>`_.
+
+Consequences
+------------
+
+See Michael Nygard's article, linked above. To create new ADRs we will copy and
+paste from existing ones.
diff --git a/docs/explanations/why-is-something-so.rst b/docs/explanations/why-is-something-so.rst
diff --git a/docs/reference.rst b/docs/reference.rst
@@ -3,7 +3,7 @@
 Reference
 =========
 
-Practical step-by-step guides for the more experienced user.
+Technical reference material including APIs and release notes.
 
 .. toctree::
     :caption: Reference
diff --git a/docs/tutorials/installation.rst b/docs/tutorials/installation.rst
@@ -4,7 +4,7 @@ Installation
 Check your version of python
 ----------------------------
 
-You will need python 3.7 or later. You can check your version of python by
+You will need python 3.8 or later. You can check your version of python by
 typing into a terminal::
 
     python3 --version
@@ -36,3 +36,10 @@ The library should now be installed and the commandline interface on your path.
 You can check the version that has been installed by typing::
 
     python3-pip-skeleton --version
+
+Running in a container
+----------------------
+
+To pull the container from github container registry and run::
+    
+    docker run ghcr.io/epics-containers/python3-pip-skeleton:main --version
diff --git a/pyproject.toml b/pyproject.toml
@@ -1,8 +1,5 @@
 [build-system]
-# To get a reproducible wheel, wheel must be pinned to the same version as in
-# dls-python3, and setuptools must produce the same dist-info. Cap setuptools
-# to the last version that didn't add License-File to METADATA
-requires = ["setuptools<57", "wheel==0.33.1"]
+requires = ["setuptools>=64", "setuptools_scm[toml]>=6.2", "wheel"]
 build-backend = "setuptools.build_meta"
 
 [tool.setuptools_scm]
diff --git a/setup.cfg b/setup.cfg
@@ -114,8 +114,6 @@ skipinstall=true
 passenv =
     PYTHONPATH
     HOME
-setenv =
-    QT_QPA_PLATFORM = offscreen
 allowlist_externals = 
     pytest 
     pre-commit
diff --git a/tests/test_boilerplate_removed.py b/tests/test_boilerplate_removed.py
@@ -24,11 +24,6 @@ def assert_not_contains_text(path: str, text: str, explanation: str):
         skeleton_check(text in contents, f"Please change ./{path} {explanation}")
 
 
-def assert_not_exists(path: str, explanation: str):
-    exists = (ROOT / path).exists()
-    skeleton_check(exists, f"Please delete ./{path} {explanation}")
-
-
 # setup.cfg
 def test_module_description():
     conf = configparser.ConfigParser()
@@ -50,15 +45,17 @@ def test_changed_README_intro():
     )
 
 
-def test_changed_README_body():
+def test_removed_adopt_skeleton():
     assert_not_contains_text(
         "README.rst",
-        "This is where you should put some images or code snippets",
-        "to include some features and why people should use it",
+        "This project contains template code only",
+        "remove the note at the start",
     )
 
 
-def test_explanations_written():
-    assert_not_exists(
-        "docs/explanations/why-is-something-so.rst", "and write some docs/explanations"
+def test_changed_README_body():
+    assert_not_contains_text(
+        "README.rst",
+        "This is where you should put some images or code snippets",
+        "to include some features and why people should use it",
     )
diff --git a/tests/test_cli.py b/tests/test_cli.py

-Original file line number
+Diff line change
 .mypy_cache
 .tox
 .venv*
 +venv*