Migrate from hatch to uv (#665)

Author: jacobtomlinson

.github/workflows/release.yaml

@@ -16,8 +16,10 @@ jobs:
       - uses: actions/checkout@v3
         with:
           fetch-depth: 0
+      - name: Install uv
+        uses: astral-sh/setup-uv@v6
       - name: Build package
-        run: pipx install hatch && hatch build
+        run: uv build
       - name: Publish kr8s
         uses: pypa/gh-action-pypi-publish@release/v1
   publish-kubectl-ng:

.github/workflows/test-kr8s.yaml

@@ -43,12 +43,12 @@ jobs:
       - uses: actions/setup-python@v2
         with:
           python-version: ${{ matrix.python-version }}
-      - name: Install hatch
-        run: pip install hatch
+      - name: Install uv
+        uses: astral-sh/setup-uv@v6
       - name: Run tests
         env:
           KUBERNETES_VERSION: ${{ matrix.kubernetes-version }}
-        run: hatch run test:ci
+        run: uv run task test-ci
       - name: Upload coverage reports to Codecov
         uses: codecov/codecov-action@v4
         env:

.readthedocs.yaml

@@ -4,6 +4,15 @@ build:
   os: "ubuntu-22.04"
   tools:
     python: "3.10"
-  commands:
-    - pip install hatch
-    - hatch run docs:rtd
+  jobs:
+    pre_create_environment:
+      - asdf plugin add uv
+      - asdf install uv latest
+      - asdf global uv latest
+    create_environment:
+      - uv venv "${READTHEDOCS_VIRTUALENV_PATH}"
+    install:
+      - UV_PROJECT_ENVIRONMENT="${READTHEDOCS_VIRTUALENV_PATH}" uv sync --frozen --dev
+    build:
+      html:
+        - UV_PROJECT_ENVIRONMENT="${READTHEDOCS_VIRTUALENV_PATH}" uv run task docs-rtd

docs/contributing.md

@@ -4,11 +4,11 @@ Contributions are very welcome. Check out our [open issues on GitHub](https://gi
 
 ## Development environment
 
-We recommend you develop `kr8s` inside a virtual environment. We use [hatch](https://hatch.pypa.io/) for builds, virtual environments and task running, but you can use whatever you prefer.
+We recommend you develop `kr8s` inside a virtual environment. We use [uv](https://github.com/astral-sh/uv) for builds, virtual environments and task running, but you can use whatever you prefer.
 
 ```bash
-pip install hatch
-hatch shell  # Creates the hatch venv and activates it
+pip install uv
+uv sync --dev
 ```
 
 But there are many different tools out there so feel free to use whichever you prefer and install `kr8s` in development mode.
@@ -23,7 +23,7 @@ pip install -e .
 Tests in `kr8s` are run with `pytest`. To handle testing again Kubernetes we also use [kind](https://kind.sigs.k8s.io/) via the [`pytest-kind`](https://pypi.org/project/pytest-kind/) plugin. Kind launches a Kubernetes cluster inside a single Docker container which is great for local development. All setup is handles via fixtures so as long as you have `docker` you can run the tests.
 
 ```bash
-hatch run test:run
+uv run task test
 ```
 
 Or you can install the test dependencies and invoke `pytest` yourself.
@@ -38,7 +38,7 @@ pytest kr8s
 Documentation is built with [Sphinx](https://www.sphinx-doc.org/en/master/). You can build the docs locally.
 
 ```bash
-hatch run docs:serve
+uv run task docs-serve
 ```
 
 Or you can install the docs dependencies and invoke `sphinx-build` or `sphinx-autobuild` yourself.

pyproject.toml

@@ -20,32 +20,6 @@ dependencies = [
     "python-box>=7.0.1",
     "typing_extensions>=4.12.2",
 ]
-[project.optional-dependencies]
-test = [
-    "pytest>=7.2.2",
-    "pytest-asyncio>=0.20.3",
-    "pytest-kind>=22.11.1",
-    "pytest-timeout>=2.1.0",
-    "pytest-rerunfailures>=11.1.2",
-    "pytest-cov>=4.0.0",
-    "trio>=0.22.0",
-    "types-pyyaml>=6.0",
-    "lightkube>=0.13.0",
-    "kubernetes>=26.1.0",
-    "pykube-ng>=23.6.0",
-    "kubernetes-asyncio>=24.2.3",
-    "kubernetes-validate>=1.28.0",
-]
-docs = [
-    "sphinx>=5.3.0",
-    "sphinx-autobuild>=2021.3.14",
-    "myst-parser>=1.0.0",
-    "furo>=2023.3.27",
-    "sphinx-copybutton>=0.5.1",
-    "sphinx-design>=0.3.0",
-    "sphinxcontrib-mermaid>=0.8.1",
-    "sphinx-autoapi>=2.1.0",
-]
 
 [project.urls]
 Documentation = "https://docs.kr8s.org/en/stable"
@@ -61,21 +35,12 @@ reruns = 0
 reruns_delay = 1
 asyncio_mode = "auto"
 
-[tool.hatch.envs.test]
-features = ["test"]
-
-[tool.hatch.envs.test.scripts]
-default = "pytest kr8s"
-run = "pytest kr8s"
-ci = "pytest kr8s --reruns=3"
-
-[tool.hatch.envs.docs]
-features = ["docs"]
-
-[tool.hatch.envs.docs.scripts]
-build = "sphinx-build docs/ docs/_build/"
-rtd = "sphinx-build docs/ _readthedocs/html/"
-serve = "sphinx-autobuild docs docs/_build --ignore 'docs/autoapi/**/*' --host 0.0.0.0"
+[tool.taskipy.tasks]
+test = "pytest kr8s"
+test-ci = "pytest kr8s --reruns=3"
+docs = "sphinx-build docs/ docs/_build/"
+docs-rtd = "sphinx-build docs/ _readthedocs/html/"
+docs-serve = "sphinx-autobuild docs docs/_build --ignore 'docs/autoapi/**/*' --host 0.0.0.0"
 
 [tool.hatch.build.hooks.vcs]
 version-file = "kr8s/_version.py"
@@ -90,6 +55,32 @@ source = "vcs"
 requires = ["hatchling", "hatch-vcs"]
 build-backend = "hatchling.build"
 
+[dependency-groups]
+dev = [
+    "pytest>=7.2.2",
+    "pytest-asyncio>=0.20.3",
+    "pytest-kind>=22.11.1",
+    "pytest-timeout>=2.1.0",
+    "pytest-rerunfailures>=11.1.2",
+    "pytest-cov>=4.0.0",
+    "trio>=0.22.0",
+    "types-pyyaml>=6.0",
+    "lightkube>=0.13.0",
+    "kubernetes>=26.1.0",
+    "pykube-ng>=23.6.0",
+    "kubernetes-asyncio>=24.2.3",
+    "kubernetes-validate>=1.28.0",
+    "sphinx>=5.3.0",
+    "sphinx-autobuild>=2021.3.14",
+    "myst-parser>=1.0.0",
+    "furo>=2023.3.27",
+    "sphinx-copybutton>=0.5.1",
+    "sphinx-design>=0.3.0",
+    "sphinxcontrib-mermaid>=0.8.1",
+    "sphinx-autoapi>=2.1.0",
+    "taskipy>=1.14.1",
+]
+
 [tool.ruff]
 # Enable pycodestyle (`E`) and Pyflakes (`F`) codes by default.
 select = ["D", "E", "W", "F", "I", "N", "B"]