diff --git a/.copier-answers.yml b/.copier-answers.yml index 036e260..da02ddd 100644 --- a/.copier-answers.yml +++ b/.copier-answers.yml @@ -1,5 +1,5 @@ # Changes here will be overwritten by Copier -_commit: 5.3.0 +_commit: 5.6.0 _src_path: https://github.com/DiamondLightSource/python-copier-template author_email: giles.knap@diamond.ac.uk author_name: Giles Knap diff --git a/.devcontainer/devcontainer.json b/.devcontainer/devcontainer.json index 62ed1da..34c06d6 100644 --- a/.devcontainer/devcontainer.json +++ b/.devcontainer/devcontainer.json @@ -84,6 +84,12 @@ ], // Mount the parent as /workspaces so we can pip install peers as editable "workspaceMount": "source=${localWorkspaceFolder}/..,target=/workspaces,type=bind", +<<<<<<< before updating // After the container is created, install the python project in editable form "postCreateCommand": "uv sync && uv run pre-commit install --install-hooks" +======= + // After the container is created, recreate the venv then make pre-commit first run faster + // Ensure we use system uv, as there might be a different (old) version of uv in the venv + "postCreateCommand": "/usr/bin/uv venv --clear && /usr/bin/uv sync && pre-commit install --install-hooks" +>>>>>>> after updating } diff --git a/.github/CONTRIBUTING.md b/.github/CONTRIBUTING.md index c7e3a48..74b8fd3 100644 --- a/.github/CONTRIBUTING.md +++ b/.github/CONTRIBUTING.md @@ -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.3.0/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.6.0/how-to.html). diff --git a/.github/workflows/_dist.yml b/.github/workflows/_dist.yml index ff6873d..c66dac0 100644 --- a/.github/workflows/_dist.yml +++ b/.github/workflows/_dist.yml @@ -13,7 +13,7 @@ jobs: fetch-depth: 0 - name: Install uv - uses: astral-sh/setup-uv@v8.3.2 + uses: astral-sh/setup-uv@v10.3.2 - name: Build sdist and wheel run: > diff --git a/.github/workflows/_docs.yml b/.github/workflows/_docs.yml index 7d13a9d..acc5265 100644 --- a/.github/workflows/_docs.yml +++ b/.github/workflows/_docs.yml @@ -21,7 +21,7 @@ jobs: run: sudo apt-get install graphviz - name: Install uv - uses: astral-sh/setup-uv@v8.3.2 + uses: astral-sh/setup-uv@v10.3.2 - name: Build docs run: uv run --locked tox -e docs diff --git a/.github/workflows/_release.yml b/.github/workflows/_release.yml index 14b4b26..59b9292 100644 --- a/.github/workflows/_release.yml +++ b/.github/workflows/_release.yml @@ -23,7 +23,7 @@ jobs: - name: Create GitHub Release # We pin to the SHA, not the tag, for security reasons. # https://docs.github.com/en/actions/learn-github-actions/security-hardening-for-github-actions#using-third-party-actions - uses: softprops/action-gh-release@3d0d9888cb7fd7b750713d6e236d1fcb99157228 # v3.0.2 + uses: softprops/action-gh-release@efb35369e0ad2afab669f228072c1b0d510eae64 # v3.0.3 with: prerelease: ${{ contains(github.ref_name, 'a') || contains(github.ref_name, 'b') || contains(github.ref_name, 'rc') }} files: "*" diff --git a/.github/workflows/_test.yml b/.github/workflows/_test.yml index 366ec47..b563e8b 100644 --- a/.github/workflows/_test.yml +++ b/.github/workflows/_test.yml @@ -27,7 +27,7 @@ jobs: fetch-depth: 0 - name: Install uv - uses: astral-sh/setup-uv@v8.3.2 + uses: astral-sh/setup-uv@v10.3.2 - name: Run tests run: uv run --locked tox -e tests diff --git a/.github/workflows/_tox.yml b/.github/workflows/_tox.yml index 2a3c4bb..c259f52 100644 --- a/.github/workflows/_tox.yml +++ b/.github/workflows/_tox.yml @@ -16,7 +16,7 @@ jobs: uses: actions/checkout@v7 - name: Install uv - uses: astral-sh/setup-uv@v8.3.2 + uses: astral-sh/setup-uv@v10.3.2 - name: Run tox run: uv run --locked tox -e ${{ inputs.tox }} diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml index 4d92215..814c8bf 100644 --- a/.github/workflows/ci.yml +++ b/.github/workflows/ci.yml @@ -7,6 +7,7 @@ on: tags: - "*" pull_request: + merge_group: jobs: lint: diff --git a/docs/index.md b/docs/index.md index dbf57a9..7d75b27 100644 --- a/docs/index.md +++ b/docs/index.md @@ -32,7 +32,7 @@ Documentation is split into [four categories](https://diataxis.fr), also accessi :maxdepth: 2 tutorials ``` -+++ +:::{card-footer} Tutorials for installation and typical usage. New users start here. ::: @@ -41,7 +41,7 @@ Tutorials for installation and typical usage. New users start here. :maxdepth: 2 how-to ``` -+++ +:::{card-footer} Practical step-by-step guides for the more experienced user. ::: @@ -50,7 +50,7 @@ Practical step-by-step guides for the more experienced user. :maxdepth: 2 explanations ``` -+++ +:::{card-footer} Explanations of how it works and why it works that way. ::: @@ -59,7 +59,7 @@ Explanations of how it works and why it works that way. :maxdepth: 2 reference ``` -+++ +:::{card-footer} Technical reference material including APIs and release notes. ::: diff --git a/pyproject.toml b/pyproject.toml index c7da24b..1b78fd5 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -1,12 +1,17 @@ [build-system] -requires = ["setuptools>=64", "setuptools_scm[toml]>=8"] +requires = ["setuptools>=77.0.3", "setuptools_scm[toml]>=8"] build-backend = "setuptools.build_meta" [project] name = "rtems-proxy" classifiers = [ "Development Status :: 3 - Alpha", +<<<<<<< before updating "License :: OSI Approved :: Apache Software License", +======= + "Programming Language :: Python :: 3.11", + "Programming Language :: Python :: 3.12", +>>>>>>> after updating "Programming Language :: Python :: 3.13", "Programming Language :: Python :: 3.14", ] @@ -21,13 +26,13 @@ dependencies = [ "typer", ] dynamic = ["version"] -license.file = "LICENSE" +license = "Apache-2.0" +license-files = ["LICENSE"] readme = "README.md" requires-python = ">=3.13" [dependency-groups] dev = [ - "copier", "myst-parser", "pre-commit", "pydata-sphinx-theme>=0.12", @@ -38,7 +43,7 @@ dev = [ "sphinx-autobuild", "sphinx-copybutton", "sphinx-design", - "tox-uv", + "tox-uv-bare", "types-mock", ] # builder2ibek converts the sample builder XML to ioc.yaml in the hybrid e2e @@ -62,6 +67,10 @@ GitHub = "https://github.com/epics-containers/rtems-proxy" email = "giles.knap@diamond.ac.uk" name = "Giles Knap" +[tool.uv] +# Minimum uv to fix eMudhra CA cert incident (see discuss.python.org/t/109576) +required-version = ">=0.13.5" + [tool.setuptools_scm] version_file = "src/rtems_proxy/_version.py" @@ -95,6 +104,13 @@ env_list = ["pre-commit", "type-checking", "tests", "docs"] [tool.tox.env_run_base] # Pass all environment variables to the test environments passenv = ["*"] +allowlist_externals = [ + "pyright", + "pytest", + "pre-commit", + "sphinx-build", + "sphinx-autobuild", +] [tool.tox.env.pre-commit] description = "Run pre-commit on all files" diff --git a/renovate.json b/renovate.json index dcdb4fa..f3e0ee9 100644 --- a/renovate.json +++ b/renovate.json @@ -40,6 +40,17 @@ "github-actions" ], "enabled": false + }, + { + "description": "Disable Dockerfile base images that are managed by python-copier-template", + "matchManagers": [ + "dockerfile" + ], + "matchDepNames": [ + "ubuntu", + "ghcr.io/diamondlightsource/ubuntu-devcontainer" + ], + "enabled": false } ] }