From 3ae0f0df1217f68d695ac18810b5d6c79ff1fd50 Mon Sep 17 00:00:00 2001 From: Gary Yendell Date: Mon, 9 Mar 2026 11:38:30 +0000 Subject: [PATCH] Update to copier 5.0.2 and rename FastCS -> fastcs --- .copier-answers.yml | 4 ++-- .github/CONTRIBUTING.md | 6 +++--- README.md | 12 ++++++------ catalog-info.yaml | 2 +- docs/conf.py | 4 ++-- docs/reference.md | 2 +- docs/tutorials/installation.md | 2 +- pyproject.toml | 2 +- 8 files changed, 17 insertions(+), 17 deletions(-) diff --git a/.copier-answers.yml b/.copier-answers.yml index be3b13ae1..09431b180 100644 --- a/.copier-answers.yml +++ b/.copier-answers.yml @@ -1,5 +1,5 @@ # Changes here will be overwritten by Copier -_commit: 5.0.1 +_commit: 5.0.2 _src_path: https://github.com/DiamondLightSource/python-copier-template author_email: gary.yendell@diamond.ac.uk author_name: Gary Yendell @@ -15,6 +15,6 @@ git_platform: github.com github_org: DiamondLightSource package_name: fastcs pypi: true -repo_name: FastCS +repo_name: fastcs strict_typing: false type_checker: pyright diff --git a/.github/CONTRIBUTING.md b/.github/CONTRIBUTING.md index a9bb8fcfb..c19b4cf6c 100644 --- a/.github/CONTRIBUTING.md +++ b/.github/CONTRIBUTING.md @@ -1,14 +1,14 @@ # Contribute to the project Contributions and issues are most welcome! All issues and pull requests are -handled through [GitHub](https://github.com/DiamondLightSource/FastCS/issues). Also, please check for any existing issues before +handled through [GitHub](https://github.com/DiamondLightSource/fastcs/issues). Also, please check for any existing issues before filing a new one. If you have a great idea but it involves big changes, please file a ticket before making a pull request! We want to make sure you don't spend your time coding something that might not fit the scope of the project. ## Issue or Discussion? -Github also offers [discussions](https://github.com/DiamondLightSource/FastCS/discussions) as a place to ask questions and share ideas. If +Github also offers [discussions](https://github.com/DiamondLightSource/fastcs/discussions) as a place to ask questions and share ideas. If your issue is open ended and it is not obvious when it can be "closed", please raise it as a discussion instead. @@ -24,4 +24,4 @@ It is recommended that developers use a [vscode devcontainer](https://code.visua This project was created using the [Diamond Light Source Copier Template](https://github.com/DiamondLightSource/python-copier-template) for Python projects. -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/5.0.1/how-to.html). +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/5.0.2/how-to.html). diff --git a/README.md b/README.md index 45415056c..1aeda609b 100644 --- a/README.md +++ b/README.md @@ -1,21 +1,21 @@ FastCS Logo -[![CI](https://github.com/DiamondLightSource/FastCS/actions/workflows/ci.yml/badge.svg)](https://github.com/DiamondLightSource/FastCS/actions/workflows/ci.yml) -[![Coverage](https://codecov.io/gh/DiamondLightSource/FastCS/branch/main/graph/badge.svg)](https://codecov.io/gh/DiamondLightSource/FastCS) +[![CI](https://github.com/DiamondLightSource/fastcs/actions/workflows/ci.yml/badge.svg)](https://github.com/DiamondLightSource/fastcs/actions/workflows/ci.yml) +[![Coverage](https://codecov.io/gh/DiamondLightSource/fastcs/branch/main/graph/badge.svg)](https://codecov.io/gh/DiamondLightSource/fastcs) [![PyPI](https://img.shields.io/pypi/v/fastcs.svg)](https://pypi.org/project/fastcs) [![License](https://img.shields.io/badge/License-Apache%202.0-blue.svg)](https://www.apache.org/licenses/LICENSE-2.0) # FastCS -Source | +Source | :---: | :---: PyPI | `pip install fastcs` -Documentation | -Releases | +Documentation | +Releases | FastCS is a control system agnostic framework for building Device support in Python that will work for both EPICS and Tango without depending on either. -See https://diamondlightsource.github.io/FastCS for more detailed documentation. +See https://diamondlightsource.github.io/fastcs for more detailed documentation. diff --git a/catalog-info.yaml b/catalog-info.yaml index 20292e092..42fca2bd0 100644 --- a/catalog-info.yaml +++ b/catalog-info.yaml @@ -2,7 +2,7 @@ apiVersion: backstage.io/v1alpha1 kind: Component metadata: name: fastcs - title: FastCS + title: fastcs description: Control system agnostic framework for building Device support in Python that will work for both EPICS and Tango spec: type: library diff --git a/docs/conf.py b/docs/conf.py index eb27c97bd..88ced3f26 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -16,7 +16,7 @@ # -- General configuration ------------------------------------------------ # General information about the project. -project = "FastCS" +project = "fastcs" # The full version, including alpha/beta/rc tags. release = fastcs.__version__ @@ -172,7 +172,7 @@ # a list of builtin themes. # html_theme = "pydata_sphinx_theme" -github_repo = "FastCS" +github_repo = "fastcs" github_user = "DiamondLightSource" switcher_json = f"https://{github_user}.github.io/{github_repo}/switcher.json" switcher_exists = requests.get(switcher_json).ok diff --git a/docs/reference.md b/docs/reference.md index 977d24634..c732ac9d9 100644 --- a/docs/reference.md +++ b/docs/reference.md @@ -8,5 +8,5 @@ Technical reference material including APIs and release notes. API <_api/fastcs> genindex -Release Notes +Release Notes ``` diff --git a/docs/tutorials/installation.md b/docs/tutorials/installation.md index 8e3ea0d18..f21e848fb 100644 --- a/docs/tutorials/installation.md +++ b/docs/tutorials/installation.md @@ -31,7 +31,7 @@ If you require a feature that is not currently released you can also install from github: ``` -$ python3 -m pip install git+https://github.com/DiamondLightSource/FastCS.git +$ python3 -m pip install git+https://github.com/DiamondLightSource/fastcs.git ``` The library should now be installed. There is no application entrypoint, but the library can be imported: diff --git a/pyproject.toml b/pyproject.toml index de06d9285..f178a375c 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -76,7 +76,7 @@ dev = [ fastcs-demo = "fastcs.demo.__main__:main" [project.urls] -GitHub = "https://github.com/DiamondLightSource/FastCS" +GitHub = "https://github.com/DiamondLightSource/fastcs" [tool.setuptools_scm] version_file = "src/fastcs/_version.py"