Merge pull request #37 from cachedjdk/build-modern

Use uv (Hatch) for build; support Python 3.10-14

Author: marktsuchida

.github/workflows/ci.yml

@@ -27,23 +27,36 @@ jobs:
     strategy:
       fail-fast: false
       matrix:
-        runner: [ubuntu-latest, macos-latest, windows-latest]
         include:
-          # Only test with Python versions available on the runners.
+          # All Python versions on Ubuntu
           - runner: ubuntu-latest
-            py_versions: 3.9 3.10 3.11 3.12 3.13
+            python: "3.10"
+          - runner: ubuntu-latest
+            python: "3.11"
+          - runner: ubuntu-latest
+            python: "3.12"
+          - runner: ubuntu-latest
+            python: "3.13"
+          - runner: ubuntu-latest
+            python: "3.14"
+          # Oldest and newest Python on other platforms
           - runner: macos-latest
-            py_versions: 3.11 3.12 3.13
+            python: "3.10"
+          - runner: macos-latest
+            python: "3.14"
+          - runner: windows-latest
+            python: "3.10"
           - runner: windows-latest
-            py_versions: 3.9 3.10 3.11 3.12 3.13
-    name: test-${{ matrix.runner }}
+            python: "3.14"
+    name: test-${{ matrix.runner }}-py${{ matrix.python }}
     runs-on: ${{ matrix.runner }}
     steps:
       - uses: actions/checkout@v3
         with:
-          fetch-depth: 0  # Full history needed for setuptools_scm
-      - uses: fjwillemsen/setup-nox2@v3.0.0
-      - run: nox -p ${{ matrix.py_versions }}
+          fetch-depth: 0  # Full history needed for hatch-vcs
+      - uses: astral-sh/setup-uv@v5
+      - name: Run tests
+        run: uv run --python ${{ matrix.python }} --group test pytest
 
   docs:
     needs:
@@ -57,16 +70,12 @@ jobs:
     steps:
       - uses: actions/checkout@v3
         with:
-          fetch-depth: 0  # Full history needed for setuptools_scm
-      - uses: actions/setup-python@v4
-        with:
-          python-version: "3.x"
-      - name: Install tools
-        run: |
-          python -m pip install --user --upgrade pip setuptools nox
+          fetch-depth: 0  # Full history needed for hatch-vcs
+      - uses: astral-sh/setup-uv@v5
       - name: Build docs
-        run: |
-          python -m nox -s docs
+        run: uv run --group docs jb build docs/
+        env:
+          CJDK_HIDE_PROGRESS_BARS: "1"
       - name: Publish to gh-pages (latest)
         if: >-
           github.repository == 'cachedjdk/cjdk' &&
@@ -108,16 +117,10 @@ jobs:
     steps:
       - uses: actions/checkout@v3
         with:
-          fetch-depth: 0  # Full history needed for setuptools_scm
-      - uses: actions/setup-python@v4
-        with:
-          python-version: "3.9"
-      - name: Install tools
-        run: |
-          python -m pip install --user --upgrade pip setuptools build
+          fetch-depth: 0  # Full history needed for hatch-vcs
+      - uses: astral-sh/setup-uv@v5
       - name: Build sdist and wheel
-        run: |
-          python -m build --sdist --wheel --outdir dist .
+        run: uv build
       - name: Publish on PyPI
         if: >-
           github.repository == 'cachedjdk/cjdk' &&

.gitignore

@@ -15,5 +15,5 @@ dist/
 *.ipynb
 .ipynb_checkpoints/
 
-# Generated by setuptools_scm
+# Generated by hatch-vcs
 src/cjdk/_version.py

README.md

@@ -41,7 +41,7 @@ does not require a Java runtime to bootstrap.
 
 ## Installing
 
-**cjdk** requires Python 3.9.
+**cjdk** requires Python 3.10.
 
 ```sh
 pip install cjdk

docs/development.md

@@ -13,41 +13,24 @@ git clone https://github.com/cachedjdk/cjdk.git
 cd cjdk
 ```
 
-As usual, it is best to do all development in a virtual environment:
-
-```sh
-python -m venv venv
-echo '*' >venv/.gitignore  # Make Git ignore your venv directory
-source venv/bin/activate   # Use venv/Scripts/activate on Windows
-python -m pip install --upgrade pip setuptools
-```
-
 Make sure to enable the [pre-commit](https://pre-commit.com/) Git hooks:
 
 ```sh
-pip install pre-commit
+uv tool install pre-commit
+# Or: pipx install pre-commit
 pre-commit install
 ```
 
-To run the tests using an editable install:
-
-```sh
-pip install -e .[testing]
-pytest
-```
-
-To run the tests as they are run by CI, use [Nox](https://nox.thea.codes/):
+To run the tests:
 
 ```sh
-pip install nox
-nox
+uv run test pytest
 ```
 
 To build the documentation with [Jupyter Book](https://jupyterbook.org/):
 
 ```sh
-pip install -r docs/requirements.txt
-CJDK_HIDE_PROGRESS_BARS=1 jb build docs
+CJDK_HIDE_PROGRESS_BARS=1 uv run --group docs jb build docs/
 # Now view docs/_build/html/index.html
 ```
 
@@ -62,13 +45,6 @@ New notebook pages can be added by first creating the notebook (`.ipynb`) in
 Jupyter Lab, then running `jupytext mypage.ipynb --to myst`. Delete the
 `.ipynb` file so that the MyST (`.md`) file is the single source of truth.
 
-To build the documentation as done by CI:
-
-```sh
-rm -rf docs/_build
-nox -s docs
-```
-
 (versioning-scheme)=
 
 ## Versioning

docs/install.md

@@ -9,7 +9,7 @@ SPDX-License-Identifier: MIT
 **cjdk** is a pure Python package and does not require a pre-installed JDK or
 JRE.
 
-Python 3.9 or later is required.
+Python 3.10 or later is required.
 
 ```sh
 pip install cjdk

docs/requirements.txt

@@ -3,18 +3,15 @@
 # SPDX-License-Identifier: MIT
 
 [build-system]
-requires = [
-    "setuptools>=43",
-    "setuptools_scm[toml]>=6.2",
-]
-build-backend = "setuptools.build_meta"
+requires = ["hatchling", "hatch-vcs"]
+build-backend = "hatchling.build"
 
 [project]
 name = "cjdk"
 dynamic = ["version"]
 description = "Auto-download JDK or JRE and run Java apps from Python or CLI"
 readme = "README.md"
-requires-python = ">=3.9"
+requires-python = ">=3.10"
 license = "MIT"
 license-files = ["LICENSE.txt"]
 keywords = ["Java", "JDK", "JRE", "JVM"]
@@ -23,6 +20,11 @@ authors = [
 ]
 classifiers = [
     "Programming Language :: Python :: 3",
+    "Programming Language :: Python :: 3.10",
+    "Programming Language :: Python :: 3.11",
+    "Programming Language :: Python :: 3.12",
+    "Programming Language :: Python :: 3.13",
+    "Programming Language :: Python :: 3.14",
     "Programming Language :: Java",
     "Topic :: Software Development",
 ]
@@ -33,22 +35,35 @@ dependencies = [
     "requests >= 2.24",
 ]
 
-[project.optional-dependencies]
-testing = [
-    "flask >= 2.0",
-    "pytest >= 7.0",
-    "werkzeug >= 2.0",
-]
-
 [project.urls]
 Documentation = "https://cachedjdk.github.io/cjdk/latest"
 Repository = "https://github.com/cachedjdk/cjdk"
 
 [project.scripts]
 cjdk = "cjdk.__main__:main"
 
-[tool.setuptools_scm]
-write_to = "src/cjdk/_version.py"
+[dependency-groups]
+test = [
+    "flask >= 2.0",
+    "pytest >= 7.0",
+    "werkzeug >= 2.0",
+]
+dev = [
+    {include-group = "test"},
+]
+docs = [
+    "jgo >= 1.0",
+    "jupyter-book >= 0.13, < 2.0",
+    "jupyterlab >= 3.4",
+    "jupytext >= 1.13",
+    "sphinxcontrib-programoutput >= 0.17",
+]
+
+[tool.hatch.version]
+source = "vcs"
+
+[tool.hatch.build.hooks.vcs]
+version-file = "src/cjdk/_version.py"
 
 [tool.pytest.ini_options]
 testpaths = ["tests"]
@@ -62,5 +77,5 @@ select = ["E", "F", "UP", "B", "SIM", "I"]
 ignore = ["B006", "B007", "B011", "B017", "E501"]
 
 [tool.uv]
-# setuptools_scm compatibility
+# hatch-vcs compatibility
 cache-keys = [{file = "pyproject.toml"}, {git = {commit = true, tags = true}}]

noxfile.py

@@ -12,9 +12,9 @@
 from . import _cache, _conf, _index, _install, _jdk
 
 if TYPE_CHECKING:
-    from collections.abc import Iterator
+    from collections.abc import Callable, Iterator
     from pathlib import Path
-    from typing import Any, Callable, Unpack
+    from typing import Any, Unpack
 
     from ._conf import ConfigKwargs