Merge pull request #10 from dls-controls/merge-test

Merge latest python3-pip-skeleton

.devcontainer/Dockerfile

@@ -4,8 +4,7 @@
 # container. The devcontainer should be rootful and use podman or docker 
 # with user namespaces.
 
-ARG BASE="mcr.microsoft.com/vscode/devcontainers/python:0-3.10-bullseye"
-FROM ${BASE} as base
+FROM python:3.9 as base
 
 # use root to pin where the packages will install
 USER root

.devcontainer/devcontainer.json

@@ -39,10 +39,6 @@
         "nsd.vscode-epics",
         "alefragnani.bookmarks"
     ],
-    "features": {
-        //"docker-from-docker": "20.10",
-        "git": "os-provided"
-    },
     // Use 'forwardPorts' to make a list of ports inside the container available locally.
     // "forwardPorts": [],
     // Comment out to connect as root instead. More info: https://aka.ms/vscode-remote/containers/non-root.

.gitattributes

@@ -1,2 +1 @@
-* module-contact=hgv27681
 src/*/_version_git.py export-subst

.github/workflows/code.yml

@@ -45,13 +45,13 @@ jobs:
           SOURCE_DATE_EPOCH=$(git log -1 --pretty=%ct) pipx run build --sdist --wheel
 
       - name: Upload Wheel and Sdist as artifacts
-        uses: actions/upload-artifact@v2
+        uses: actions/upload-artifact@v3
         with:
           name: dist
           path: dist
 
       - name: Install minimum python version
-        uses: actions/setup-python@v2
+        uses: actions/setup-python@v4
         with:
           python-version: ${{ matrix.python }}
 
@@ -88,7 +88,7 @@ jobs:
           fetch-depth: 0
 
       - name: Setup python ${{ matrix.python }}
-        uses: actions/setup-python@v2
+        uses: actions/setup-python@v4
         with:
           python-version: ${{ matrix.python }}
 
@@ -122,7 +122,7 @@ jobs:
 
       - name: Upload build files
         if: matrix.lock
-        uses: actions/upload-artifact@v2
+        uses: actions/upload-artifact@v3
         with:
           name: buildfiles
           path: |
@@ -135,7 +135,7 @@ jobs:
     # upload to PyPI and make a release on every tag
     if: github.event_name == 'push' && startsWith(github.ref, 'refs/tags')
     steps:
-      - uses: actions/download-artifact@v2
+      - uses: actions/download-artifact@v3
         with:
           path: artifacts
 
@@ -168,7 +168,7 @@ jobs:
       - name: Checkout
         uses: actions/checkout@v2
 
-      - uses: actions/download-artifact@v2
+      - uses: actions/download-artifact@v3
         with:
           name: dist
           path: dist
@@ -183,7 +183,7 @@ jobs:
 
       - name: Log in to GitHub Docker Registry
         if: github.event_name != 'pull_request'
-        uses: docker/login-action@v1
+        uses: docker/login-action@v2
         with:
           registry: ghcr.io
           username: ${{ github.actor }}
@@ -201,10 +201,10 @@ jobs:
 
       - name: Set up Docker Buildx
         id: buildx
-        uses: docker/setup-buildx-action@v1
+        uses: docker/setup-buildx-action@v2
 
       - name: Build runtime image
-        uses: docker/build-push-action@v2
+        uses: docker/build-push-action@v3
         with:
           file: .devcontainer/Dockerfile
           context: .

.github/workflows/docs.yml

@@ -26,7 +26,7 @@ jobs:
         run: sleep 60
 
       - name: Install python version
-        uses: actions/setup-python@v2
+        uses: actions/setup-python@v4
         with:
           python-version: ${{ matrix.python }}
 

.github/workflows/linkcheck.yml

@@ -26,7 +26,7 @@ jobs:
           fetch-depth: 0
 
       - name: Install python version
-        uses: actions/setup-python@v2
+        uses: actions/setup-python@v4
         with:
           python-version: ${{ matrix.python }}
 

.gitignore

@@ -8,7 +8,7 @@ __pycache__/
 # Distribution / packaging
 .Python
 env/
-.venv*
+.venv
 build/
 develop-eggs/
 dist/
@@ -65,5 +65,6 @@ target/
 /venv/
 /lightweight-venv/
 /installed.files
+.venv*
 src/epicscorelibs
 

CONTRIBUTING.rst

@@ -149,7 +149,7 @@ Python project structure which provides a means to keep tools and
 techniques in sync between multiple Python projects. To update to the
 latest version of the skeleton, run::
 
-    $ git pull https://github.com/dls-controls/python3-pip-skeleton skeleton
+    $ git pull https://github.com/dls-controls/python3-pip-skeleton main
 
 Any merge conflicts will indicate an area where something has changed that
 conflicts with the setup of the current module. Check the `closed pull requests

docs/explanations.rst

@@ -9,3 +9,4 @@ Explanation of how the library works and why it works that way.
     :caption: Explanations
 
     explanations/todo
+

docs/how-to.rst

@@ -9,3 +9,4 @@ Practical step-by-step guides for the more experienced user.
     :caption: How-to Guides
 
     how-to/todo
+

setup.cfg

@@ -15,7 +15,8 @@ classifiers =
     Programming Language :: Python :: 3.10
 
 [options]
-python_requires = >=3.7
+
+python_requires = >=3.8
 packages = find:
 
 # =src is interpreted as {"": "src"}
@@ -38,12 +39,11 @@ install_requires =
     gitpython
     attrs>=19.1.0
     requests
-    types-requests
 
 [options.extras_require]
 # For development tests/docs
 dev =
-    black==22.3.0
+    black==22.6.0
     pipdeptree
     flake8-isort
     isort>5.0
@@ -54,9 +54,9 @@ dev =
     tox
     setuptools_scm[toml]>=6.2
     types-mock
-    sphinx==4.3.2
     sphinx-rtd-theme-github-versions
     sphinx-apischema
+    types-requests
 
 [options.packages.find]
 where = src
@@ -77,6 +77,7 @@ console_scripts =
 [mypy]
 # Ignore missing stubs for modules we use
 ignore_missing_imports = True
+exclude = src/epicscorelibs
 
 [isort]
 profile=black
@@ -140,4 +141,4 @@ commands =
     pytest: pytest tests {posargs}
     mypy: mypy src tests {posargs}
     pre-commit: pre-commit run --all-files {posargs}
-    docs: sphinx-build -EWT --keep-going docs build/html {posargs} 
+    docs: sphinx-build -EWT --keep-going docs build/html {posargs}