DX: migrate to uv environment

.cspell.json

@@ -18,7 +18,6 @@
     "**/.cspell.json",
     ".editorconfig",
     ".envrc",
-    ".gitattributes",
     ".gitignore",
     ".pre-commit-config.yaml",
     ".prettierignore",
@@ -52,7 +51,8 @@
     "refuri",
     "rtfd",
     "srcdir",
-    "templatedir"
+    "templatedir",
+    "venv"
   ],
   "enableFiletypes": [
     "git-commit",

.editorconfig

@@ -18,3 +18,6 @@ indent_size = unset
 
 [setup.cfg]
 indent_size = 4
+
+[uv.lock]
+indent_size = 4

.envrc

@@ -1,10 +1,2 @@
-if [ -e .venv ]; then
-  source .venv/bin/activate
-elif [ -e venv ]; then
-  source venv/bin/activate
-elif [ -e .pixi ]; then
-  watch_file pixi.lock
-  eval "$(pixi shell-hook)"
-else
-  layout anaconda
-fi
+uv sync --all-extras --quiet
+source .venv/bin/activate

.gitignore

@@ -30,7 +30,6 @@ version.py
 
 # Temporary files
 *.pyc
-*condaenv.*
 .coverage
 .coverage.*
 .ipynb_checkpoints/
@@ -42,7 +41,6 @@ prof/
 
 # Virtual environments
 *venv/
-.pixi/
 .tox/
 pyvenv*/
 
@@ -60,5 +58,4 @@ pyvenv*/
 !.readthedocs.yml
 !.vscode/*.json
 !codecov.yml
-!environment.yml
 !pyrightconfig.json

.pre-commit-config.yaml

@@ -1,9 +1,10 @@
 ci:
-  autoupdate_commit_msg: "MAINT: autoupdate pre-commit hooks"
+  autoupdate_commit_msg: "MAINT: update lock files"
   autoupdate_schedule: quarterly # already done by requirements-cron.yml
   skip:
     - mypy
     - pyright
+    - uv-lock
 
 repos:
   - repo: meta
@@ -12,11 +13,10 @@ repos:
       - id: check-useless-excludes
 
   - repo: https://github.com/ComPWA/policy
-    rev: 0.4.2
+    rev: 0.5.0rc0
     hooks:
       - id: check-dev-files
         args:
-          - --no-notebooks
           - --no-prettierrc
           - --repo-name=sphinx-api-relink
           - --repo-title=sphinx-api-relink
@@ -95,3 +95,8 @@ repos:
     rev: v1.1.384
     hooks:
       - id: pyright
+
+  - repo: https://github.com/astral-sh/uv-pre-commit
+    rev: 0.4.20
+    hooks:
+      - id: uv-lock

.python-version

@@ -0,0 +1 @@
+3.12

.vscode/settings.json

@@ -36,9 +36,6 @@
   "coverage-gutters.showLineCoverage": true,
   "diffEditor.experimental.showMoves": true,
   "editor.formatOnSave": true,
-  "files.associations": {
-    "**/pixi.lock": "yaml"
-  },
   "files.watcherExclude": {
     "**/*_cache/**": true,
     "**/.eggs/**": true,
@@ -64,5 +61,8 @@
   "ruff.enable": true,
   "ruff.importStrategy": "fromEnvironment",
   "ruff.organizeImports": true,
+  "search.exclude": {
+    "**/uv.lock": true
+  },
   "telemetry.telemetryLevel": "off"
 }

CONTRIBUTING.md

@@ -1,5 +1,26 @@
 # How to contribute?
 
-[![Open in Visual Studio Code](https://img.shields.io/badge/vscode-open-blue?logo=visualstudiocode)](https://open.vscode.dev/ComPWA/sphinx-api-relink)
+[![Open in Visual Studio Code](https://img.shields.io/badge/vscode-open-blue?logo=visualstudiocode)](https://github.dev/ComPWA/sphinx-api-relink)
 
-This package is part of the [ComPWA Organization](https://github.com/ComPWA). For more information about how to contribute to the packages, go to **[compwa.github.io/develop](https://compwa.github.io/develop)**!
+> [!TIP]
+> This package is part of the [ComPWA Organization](https://github.com/ComPWA). For more information about how to contribute to the packages, go to **[compwa.github.io/develop](https://compwa.github.io/develop)**!
+
+To contribute to the project, you need to install the package in a virtual environment. This can be done best with [`uv`](https://docs.astral.sh/uv) (see installation instructions [here](https://docs.astral.sh/uv/getting-started/installation)). For this, you first need to get the source code with [Git](https://git-scm.com):
+
+```shell
+git clone https://github.com/ComPWA/sphinx-api-relink
+cd sphinx-api-relink
+```
+
+Now it's simply a matter of creating and activating the [virtual environment](https://docs.astral.sh/uv/pip/environments) with [`uv sync`](https://docs.astral.sh/uv/reference/cli/#uv-sync). The dependencies for the project are 'pinned' in each commit through the [`uv.lock` file](https://docs.astral.sh/uv/concepts/projects/#project-lockfile).
+
+```shell
+uv sync
+source .venv/bin/activate
+```
+
+Formatting and linting checks are automatically performed when committing changes. This is done with [pre-commit](https://pre-commit.com). To install the hooks in your local repository, run [`pre-commit install`](https://pre-commit.com/#3-install-the-git-hook-scripts) **once**:
+
+```shell
+pre-commit install --install-hooks
+```

README.md

@@ -10,6 +10,7 @@
 [![Spelling checked](https://img.shields.io/badge/cspell-checked-brightgreen.svg)](https://github.com/streetsidesoftware/cspell/tree/master/packages/cspell)
 [![code style: prettier](https://img.shields.io/badge/code_style-prettier-ff69b4.svg?style=flat-square)](https://github.com/prettier/prettier)
 [![Ruff](https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/charliermarsh/ruff/main/assets/badge/v2.json)](https://github.com/astral-sh/ruff)
+[![uv](https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/astral-sh/uv/main/assets/badge/v0.json)](https://github.com/astral-sh/uv)
 
 This package is a plugin for the [`sphinx.ext.autodoc`](https://www.sphinx-doc.org/en/master/usage/extensions/autodoc.html) extension. The [`autodoc_type_aliases`](https://www.sphinx-doc.org/en/master/usage/extensions/autodoc.html#confval-autodoc_type_aliases) configuration does not always work well when using postponed evaluation of annotations ([PEP 563](https://peps.python.org/pep-0563), i.e. `from __future__ import annotations`) or when importing through [`typing.TYPE_CHECKING`](https://docs.python.org/3/library/typing.html#typing.TYPE_CHECKING), because `sphinx.ext.autodoc` generates the API dynamically (not statically, as opposed to [`sphinx-autoapi`](https://github.com/readthedocs/sphinx-autoapi)).
 

pyproject.toml

@@ -81,7 +81,7 @@ where = ["src"]
 
 [tool.setuptools_scm]
 local_scheme = "no-local-version"
-version_scheme = "post-release"
+version_scheme = "only-version"
 write_to = "src/version.py"
 
 [tool.coverage.run]
@@ -98,33 +98,14 @@ files = [
 show_error_codes = true
 warn_unused_configs = true
 
-[tool.pixi.project]
-channels = ["conda-forge"]
-platforms = ["linux-64"]
-
-[tool.pixi.activation.env]
-PRETTIER_LEGACY_CLI = "1"
-
-[tool.pixi.dependencies]
-python = "3.12.*"
-
-[tool.pixi.environments]
-default = {features = [
-    "dev",
-    "sty",
-    "types",
-]}
-
-[tool.pixi.pypi-dependencies]
-sphinx-api-relink = {path = ".", editable = true}
-
 [tool.pyright]
 exclude = [
     "**/.git",
     "**/.ipynb_checkpoints",
     "**/.mypy_cache",
     "**/.pytest_cache",
     "**/.tox",
+    "**/.venv/",
     "**/__pycache__",
     "**/_build",
 ]