Merge pull request #5 from dls-controls/dev

Changes from merging to pvi module

Author: coretl

.github/workflows/code.yml

@@ -3,6 +3,9 @@ name: Code CI
 on:
   push:
     branches:
+      # Restricting to these branches and tags stops duplicate jobs on internal
+      # PRs but stops CI running on internal branches without a PR. Delete the
+      # next 5 lines to restore the original behaviour
       - master
       - main
     tags:

.github/workflows/docs.yml

@@ -19,6 +19,10 @@ jobs:
         if: startsWith(github.ref, 'refs/tags')
         run: sleep 60
 
+      - name: Install Packages
+        # Can delete this if you don't use graphviz in your docs
+        run: sudo apt-get install graphviz
+
       - name: Build docs
         uses: dls-controls/pipenv-run-action@v1
         with:

CHANGELOG.rst

@@ -6,12 +6,12 @@ All notable changes to this project will be documented in this file.
 The format is based on `Keep a Changelog <https://keepachangelog.com/en/1.0.0/>`_,
 and this project adheres to `Semantic Versioning <https://semver.org/spec/v2.0.0.html>`_.
 
-.. note::
-
-    This is a template changelog to be inherited by projects using this skeleton
-    module. The changelog for the skeleton module is the list of `closed pull requests
-    <https://github.com/dls-controls/dls-python3-skeleton/pulls?q=is%3Apr+is%3Aclosed>`_
+Note
+----
 
+This is a template changelog to be inherited by projects using this skeleton
+module. The changelog for the skeleton module is the list of `closed pull requests
+<https://github.com/dls-controls/dls-python3-skeleton/pulls?q=is%3Apr+is%3Aclosed>`_
 
 `Unreleased <../../compare/0.2...HEAD>`_
 ----------------------------------------

setup.cfg

@@ -69,6 +69,8 @@ extend-ignore =
 addopts =
     --tb=native -vv --doctest-modules --doctest-glob="*.rst"
     --cov=dls_python3_skeleton --cov-report term --cov-report xml:cov.xml
+# https://iscinumpy.gitlab.io/post/bound-version-constraints/#watch-for-warnings
+filterwarnings = error
 
 [coverage:run]
 # This is covered in the versiongit test suite so exclude it here

src/dls_python3_skeleton/_version_git.py

@@ -16,7 +16,7 @@
 
 
 def get_version_from_git(path=None):
-    """Try to parse version from git describe, fallback to git archive tags"""
+    """Try to parse version from git describe, fallback to git archive tags."""
     tag, plus, suffix = "0.0", "untagged", ""
     if not GIT_SHA1.startswith("$"):
         # git archive or the cmdclasses below have filled in these strings
@@ -61,8 +61,11 @@ def get_version_from_git(path=None):
 
 
 def get_cmdclass(build_py=None, sdist=None):
-    """Create cmdclass dict to pass to setuptools.setup that will write a
-    _version_static.py file in our resultant sdist, wheel or egg"""
+    """Create cmdclass dict to pass to setuptools.setup.
+
+    Create cmdclass dict to pass to setuptools.setup which will write a
+    _version_static.py file in our resultant sdist, wheel or egg.
+    """
     if build_py is None:
         from setuptools.command.build_py import build_py
     if sdist is None: