Merge pull request #330 from bluesky/updated-to-copier-template-2.4.0

fixed linkcheck by updating copier
bluesky · Oct 30, 2024 · 2649a8e · 2649a8e
2 parents a1fdaec + 102580e
commit 2649a8e
Show file tree

Hide file tree

Showing 5 changed files with 60 additions and 56 deletions.
diff --git a/.copier-answers.yml b/.copier-answers.yml
@@ -1,5 +1,5 @@
 # Changes here will be overwritten by Copier
-_commit: 2.3.0
+_commit: 2.4.0
 _src_path: gh:DiamondLightSource/python-copier-template
 author_email: [email protected]
 author_name: Brookhaven National Lab

diff --git a/.github/CONTRIBUTING.md b/.github/CONTRIBUTING.md
@@ -8,7 +8,6 @@
   * Make sure you fill in the earliest version that you know has the issue.
 * Fork the repository on GitHub
 
-
 ## Making Changes
 
 * Create a topic branch from where you want to base your work.
@@ -38,12 +37,13 @@ characters.  If the commit is related to a ticket, indicate that with
 "See #3456", "See ticket 3456", "Closes #3456" or similar.
 ```
 
-Describing the motivation for a change, the nature of a bug for bug fixes 
-or some details on what an enhancement does are also good to include in a 
-commit message. Messages should be understandable without looking at the code 
-changes. 
+Describing the motivation for a change, the nature of a bug for bug fixes
+or some details on what an enhancement does are also good to include in a
+commit message. Messages should be understandable without looking at the code
+changes.
 
 Standard acronyms to start the commit message with are:
+
 ```
 API: an (incompatible) API change
 BLD: change related to building numpy
@@ -59,16 +59,20 @@ STY: style fix (whitespace, PEP8)
 TST: addition or modification of tests
 REL: related to releases
 ```
+
 ## The Pull Request
 
 * Now push to your fork
 * Submit a [pull request](https://help.github.com/articles/using-pull-requests) to this branch. This is a start to the conversation.
 
-At this point you're waiting on us. We like to at least comment on pull requests within three business days 
+At this point you're waiting on us. We like to at least comment on pull requests within three business days
 (and, typically, one business day). We may suggest some changes or improvements or alternatives.
 
 Hints to make the integration of your changes easy (and happen faster):
-- Keep your pull requests small
-- Don't forget your unit tests
-- All algorithms need documentation, don't forget the .rst file
-- Don't take changes requests to change your code personally
+
+* Keep your pull requests small
+* Don't forget your unit tests
+* All algorithms need documentation, don't forget the .rst file
+* Don't take changes requests to change your code personally
+
+For more information on common tasks like setting up a developer environment, running the tests, and setting a pre-commit hook, see the template's [How-to guides](https://diamondlightsource.github.io/python-copier-template/2.4.0/how-to.html).
diff --git a/Dockerfile b/Dockerfile
@@ -1,7 +1,7 @@
 # The devcontainer should use the developer target and run as root with podman
 # or docker with user namespaces.
 ARG PYTHON_VERSION=3.11
-FROM python:${PYTHON_VERSION} as developer
+FROM python:${PYTHON_VERSION} AS developer
 
 # Add any system dependencies for the developer/build environment here
 RUN apt-get update && apt-get install -y --no-install-recommends \

diff --git a/README.md b/README.md
@@ -4,7 +4,7 @@
 [![CI](https://github.com/bluesky/event-model/actions/workflows/ci.yml/badge.svg)](https://github.com/bluesky/event-model/actions/workflows/ci.yml)
 [![Coverage](https://codecov.io/gh/bluesky/event-model/branch/main/graph/badge.svg)](https://codecov.io/gh/bluesky/event-model)
 [![PyPI](https://img.shields.io/pypi/v/event-model.svg)](https://pypi.org/project/event-model)
-[![License](https://img.shields.io/badge/License-Apache%202.0-blue.svg)](https://opensource.org/licenses/Apache-2.0)
+[![License](https://img.shields.io/badge/License-Apache%202.0-blue.svg)](https://www.apache.org/licenses/LICENSE-2.0)
 
 Data model used by the bluesky ecosystem.
 

diff --git a/pyproject.toml b/pyproject.toml
@@ -5,20 +5,20 @@ build-backend = "setuptools.build_meta"
 [project]
 name = "event-model"
 classifiers = [
-    "Development Status :: 3 - Alpha",
-    "License :: OSI Approved :: BSD License",
-    "Programming Language :: Python :: 3.8",
-    "Programming Language :: Python :: 3.9",
-    "Programming Language :: Python :: 3.10",
-    "Programming Language :: Python :: 3.11",
-    "Programming Language :: Python :: 3.12",
+  "Development Status :: 3 - Alpha",
+  "License :: OSI Approved :: BSD License",
+  "Programming Language :: Python :: 3.8",
+  "Programming Language :: Python :: 3.9",
+  "Programming Language :: Python :: 3.10",
+  "Programming Language :: Python :: 3.11",
+  "Programming Language :: Python :: 3.12",
 ]
 description = "Data model used by the bluesky ecosystem."
 dependencies = [
-    "importlib-resources",
-    "jsonschema>=4",
-    "numpy",
-    "typing_extensions"
+  "importlib-resources",
+  "jsonschema>=4",
+  "numpy",
+  "typing_extensions",
 ]
 dynamic = ["version"]
 license.file = "LICENSE"
@@ -27,30 +27,30 @@ requires-python = ">=3.8"
 
 [project.optional-dependencies]
 dev = [
-    "mypy",
-    "myst-parser",
-    "pipdeptree",
-    "pre-commit",
-    "pydata-sphinx-theme>=0.12",
-    "pytest",
-    "pytest-cov",
-    "ruff",
-    "sphinx-autobuild",
-    "sphinx-copybutton",
-    "sphinx-design",
-    "tox-direct",
-    "types-mock",
-
-    # Until https://github.com/copier-org/copier/issues/1819 is released.
-    "copier==9.3.1",
-
-    # These are dependencies of various sphinx extensions for documentation.
-    "ipython",
-    "matplotlib",
-    "numpydoc",
-
-    # For schema generation.
-    "pydantic>=2.6",
+  "mypy",
+  "myst-parser",
+  "pipdeptree",
+  "pre-commit",
+  "pydata-sphinx-theme>=0.12",
+  "pytest",
+  "pytest-cov",
+  "ruff",
+  "sphinx-autobuild",
+  "sphinx-copybutton",
+  "sphinx-design",
+  "tox-direct",
+  "types-mock",
+
+  # For updating the copier template.
+  "copier",
+
+  # These are dependencies of various sphinx extensions for documentation.
+  "ipython",
+  "matplotlib",
+  "numpydoc",
+
+  # For schema generation.
+  "pydantic>=2.6",
 ]
 
 [project.scripts]
@@ -115,14 +115,14 @@ commands =
 src = ["src"]
 line-length = 88
 lint.select = [
-    "B",   # flake8-bugbear - https://docs.astral.sh/ruff/rules/#flake8-bugbear-b
-    "C4",  # flake8-comprehensions - https://docs.astral.sh/ruff/rules/#flake8-comprehensions-c4
-    "E",   # pycodestyle errors - https://docs.astral.sh/ruff/rules/#error-e
-    "F",   # pyflakes rules - https://docs.astral.sh/ruff/rules/#pyflakes-f
-    "W",   # pycodestyle warnings - https://docs.astral.sh/ruff/rules/#warning-w
-    "I",   # isort - https://docs.astral.sh/ruff/rules/#isort-i
-    "UP",  # pyupgrade - https://docs.astral.sh/ruff/rules/#pyupgrade-up
-    "SLF", # self - https://docs.astral.sh/ruff/settings/#lintflake8-self
+  "B",   # flake8-bugbear - https://docs.astral.sh/ruff/rules/#flake8-bugbear-b
+  "C4",  # flake8-comprehensions - https://docs.astral.sh/ruff/rules/#flake8-comprehensions-c4
+  "E",   # pycodestyle errors - https://docs.astral.sh/ruff/rules/#error-e
+  "F",   # pyflakes rules - https://docs.astral.sh/ruff/rules/#pyflakes-f
+  "W",   # pycodestyle warnings - https://docs.astral.sh/ruff/rules/#warning-w
+  "I",   # isort - https://docs.astral.sh/ruff/rules/#isort-i
+  "UP",  # pyupgrade - https://docs.astral.sh/ruff/rules/#pyupgrade-up
+  "SLF", # self - https://docs.astral.sh/ruff/settings/#lintflake8-self
 ]
 
 [tool.ruff.lint.per-file-ignores]