Switch from pip to uv

Author: object-Object

.github/workflows/ci.yml

@@ -2,37 +2,19 @@ name: Run CI/CD pipeline
 
 on:
   push:
-    branches: "*"
+    branches: ["*"]
   pull_request:
   workflow_dispatch:
 
 permissions:
   contents: read
 
 jobs:
-  setup:
-    runs-on: ubuntu-latest
-    outputs:
-      is-main-branch: |-
-        ${{
-          github.event_name != 'pull_request' && contains(
-            fromJson('["main", "1.19"]'),
-            (github.head_ref || github.ref_name)
-          )
-        }}
-    steps:
-      - name: Print message so the workflow isn't invalid
-        run: 'echo "HexDebug <3 HexBug"'
-
   build-docs:
-    needs: setup
-    uses: hexdoc-dev/actions/.github/workflows/hexdoc.yml@v1
+    uses: ./.github/workflows/docs.yml
     permissions:
       contents: write
       pages: read
-    secrets:
-      GH_TOKEN: ${{ secrets.GITHUB_TOKEN }}
     with:
-      python-version: 3.11
-      deploy-pages: ${{ needs.setup.outputs.is-main-branch == 'true' }}
+      deploy-pages: ${{ github.event_name != 'pull_request' && contains(fromJson(vars.HEXDOC_BRANCHES), github.ref_name) }}
       release: false

.github/workflows/docs.yml

@@ -0,0 +1,80 @@
+name: "[Reusable] Build and push the web book"
+
+on:
+  workflow_call:
+    inputs:
+      deploy-pages:
+        type: boolean
+        required: true
+      release:
+        type: boolean
+        required: true
+        description: Whether the book should be built in preparation for a release.
+
+jobs:
+  build-hexdoc:
+    runs-on: ubuntu-latest
+    permissions:
+      contents: read
+      pages: read
+    outputs:
+      pages-url: ${{ steps.build.outputs.pages-url }}
+    steps:
+      - uses: actions/checkout@v4
+
+      - uses: actions/setup-python@v6
+        with:
+          python-version-file: .python-version
+
+      - uses: astral-sh/setup-uv@v6
+        with:
+          activate-environment: true
+          enable-cache: true
+
+      - name: Sync dependencies
+        run: uv sync --frozen --no-dev
+
+      - id: build
+        uses: hexdoc-dev/actions/build@v1
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+        with:
+          release: ${{ inputs.release }}
+
+  deploy-pages:
+    needs: build-hexdoc
+    if: inputs.deploy-pages
+    runs-on: ubuntu-latest
+    concurrency:
+      group: hexdoc-deploy-pages
+      cancel-in-progress: false
+    permissions:
+      contents: write
+    steps:
+      - uses: actions/checkout@v4
+
+      - uses: actions/setup-python@v6
+        with:
+          python-version-file: .python-version
+
+      - uses: astral-sh/setup-uv@v6
+        with:
+          activate-environment: true
+          enable-cache: true
+
+      - name: Sync dependencies
+        run: uv sync --frozen --no-dev
+
+      - name: Merge new hexdoc build into existing book
+        uses: hexdoc-dev/actions/merge@v1
+        with:
+          release: ${{ inputs.release }}
+          site-url: ${{ needs.build-hexdoc.outputs.pages-url }}
+
+      # if you want to add extra things to your website (eg. Javadoc/Dokka), add it to _site/dst/docs here
+
+      - name: Deploy to Pages
+        uses: hexdoc-dev/actions/deploy-pages@v1
+        with:
+          merge: false
+          release: ${{ inputs.release }}

.github/workflows/release.yml

@@ -2,13 +2,10 @@ name: Release
 
 on:
   push:
-    tags: 'v[0-9]+.[0-9]+.[0-9]+*'
+    tags:
+      - 'v[0-9]+.[0-9]+.[0-9]+*'
   workflow_dispatch:
     inputs:
-      publish-docs:
-        description: Publish the web book
-        type: boolean
-        default: false
       dry-run:
         description: Perform a dry run
         type: boolean
@@ -22,20 +19,17 @@ permissions:
 
 jobs:
   build-docs:
-    uses: hexdoc-dev/actions/.github/workflows/hexdoc.yml@v1
+    uses: ./.github/workflows/docs.yml
     permissions:
       contents: write
       pages: read
-    secrets:
-      GH_TOKEN: ${{ secrets.GITHUB_TOKEN }}
     with:
-      python-version: 3.11
-      deploy-pages: ${{ github.event_name == 'push' || inputs.publish-docs && !inputs.dry-run }}
+      deploy-pages: ${{ github.event_name == 'push' || !inputs.dry-run }}
       release: true
 
-  publish-docs:
+  publish-pypi:
     needs: build-docs
-    if: github.event_name == 'push' || inputs.publish-docs && !inputs.dry-run
+    if: github.event_name == 'push' || !inputs.dry-run
     runs-on: ubuntu-latest
     environment:
       name: pypi

.python-version

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

doc/README.md

@@ -15,17 +15,14 @@ For example:
 
 ## Setup
 
-Install Python 3.11 and Node 18 (20+ is **not** currently supported).
+Install [uv](https://docs.astral.sh/uv/getting-started/installation/), then:
 
 ```sh
-python3.11 -m venv venv
+uv sync
 
-.\venv\Scripts\activate   # Windows
-. venv/bin/activate.fish  # fish
-source venv/bin/activate  # everything else
-
-# run from the repo root, not doc/
-pip install -e .[dev]
+.\.venv\Scripts\activate   # Windows
+. .venv/bin/activate.fish  # fish
+source .venv/bin/activate  # everything else
 ```
 
 ## Usage
@@ -39,6 +36,9 @@ GITHUB_PAGES_URL=https://hexdebug.hexxy.media
 
 Useful commands:
 ```sh
+# update your Python environment and lockfile if you added new dependencies
+uv sync
+
 # show help
 hexdoc -h
 
@@ -48,9 +48,8 @@ nodemon --config doc/nodemon.json
 # render and serve the web book
 hexdoc serve
 
-# export, render, and merge the web book
-hexdoc export
-hexdoc render
+# build and merge the web book
+hexdoc build
 hexdoc merge
 
 # start the Python interpreter with some extra local variables

doc/nodemon.json

@@ -7,5 +7,5 @@
     ],
     "ignore": ["**/generated/**"],
     "ext": "jinja,html,css,js,ts,toml,json,json5,py",
-    "exec": "hexdoc serve"
+    "exec": "uv run hexdoc serve"
 }

pyproject.toml

@@ -15,14 +15,14 @@ authors = [
     { name="object-Object" },
 ]
 keywords = ["hexdoc"]
-requires-python = ">=3.11"
+requires-python = ">=3.12"
 dynamic = ["version", "dependencies", "optional-dependencies"]
 
 [project.urls]
 Homepage = "https://hexdebug.hexxy.media"
 Source = "https://github.com/object-Object/HexDebug"
 
-# Gradle version/deps
+# project version
 
 [tool.hatch.version]
 scheme = "gradle"
@@ -31,16 +31,20 @@ py-path = "doc/src/hexdoc_hexdebug/__version__.py"
 key = "modVersion"
 gradle-version-regex = { regex='^(.+?)(-.+)?$', repl='\1.{minecraftVersion}\2' }
 
+# Python dependencies
+
+# required
 [tool.hatch.metadata.hooks.version-catalog]
 dependencies = [
     "hexdoc>=1!0.1.0a34",
     { package="hexdoc-hexcasting", op="~=", py-version="1.0", key="hexcasting" },
     { package="hexdoc-ioticblocks", op=">=", py-version="1.0", key="ioticblocks" },
 ]
 
-[tool.hatch.metadata.hooks.version-catalog.optional-dependencies]
+# dev-only
+[dependency-groups]
 dev = [
-    "ruff~=0.13.1",
+    "ruff",
 ]
 
 # directory inclusion
@@ -58,26 +62,26 @@ artifacts = [
 [tool.hatch.build.targets.wheel]
 sources = ["doc/src"]
 
-# hexdoc entry points
+# hexdoc entry point
 
 [project.entry-points.hexdoc]
 hexdebug = "hexdoc_hexdebug._hooks:HexDebugPlugin"
 
 # linting/formatting
 
 [tool.ruff]
+preview = true
 extend-exclude = [
-    "venv",
+    "**/venv",
     "**/.*",
-    "**/node_modules",
     "**/__pycache__",
 ]
 
 [tool.ruff.lint]
-preview = true
 extend-select = [
     "I", # import sorting
     "RUF022", # __all__ sorting
+    "TID252", # ban relative imports
 ]
 extend-ignore = [
     # covered by Pyright
@@ -89,62 +93,50 @@ extend-ignore = [
 [tool.ruff.lint.isort]
 combine-as-imports = true
 
+[tool.ruff.lint.flake8-tidy-imports]
+ban-relative-imports = "parents"
+
+# type checking
+
 [tool.pyright]
-pythonVersion = "3.11"
+pythonVersion = "3.12"
 pythonPlatform = "All"
 
 include = ["doc/src"]
 extraPaths = ["doc/src"]
-exclude = [
-    "noxfile.py",
-    "**/venv",
-    "**/.*",
-    "**/node_modules",
-    "**/__pycache__",
-]
 
 typeCheckingMode = "standard"
 
 strictDictionaryInference = true
 strictListInference = true
 strictSetInference = true
 
-reportAssertAlwaysTrue = "error"
 reportConstantRedefinition = "error"
-reportDeprecated = "error"
-reportDuplicateImport = "error"
-reportFunctionMemberAccess = "error"
-reportIncompatibleMethodOverride = "error"
-reportIncompatibleVariableOverride = "error"
 reportIncompleteStub = "error"
 reportInconsistentConstructor = "error"
-reportInvalidStringEscapeSequence = "error"
 reportInvalidStubStatement = "error"
-reportInvalidTypeVarUse = "error"
-reportMatchNotExhaustive = "error"
-reportMissingParameterType = "error"
-reportMissingTypeStubs = "error"
-reportOverlappingOverload = "error"
-reportSelfClsParameterName = "error"
-reportTypeCommentUsage = "error"
-reportUnknownParameterType = "error"
-reportUnnecessaryCast = "error"
-reportUnnecessaryContains = "error"
-reportUnsupportedDunderAll = "error"
-reportUntypedBaseClass = "error"
-reportUntypedClassDecorator = "error"
-reportUntypedFunctionDecorator = "error"
-reportUntypedNamedTuple = "error"
-reportWildcardImportFromLibrary = "error"
 
+reportDeprecated = "warning"
+reportDuplicateImport = "warning"
+reportMatchNotExhaustive = "warning"
+reportMissingParameterType = "warning"
 reportMissingTypeArgument = "warning"
+reportMissingTypeStubs = "warning"
 reportPrivateUsage = "warning"
+reportTypeCommentUsage = "warning"
 reportUnknownArgumentType = "warning"
 reportUnknownLambdaType = "warning"
 reportUnknownMemberType = "warning"
+reportUnknownParameterType = "warning"
 reportUnknownVariableType = "warning"
+reportUnnecessaryCast = "warning"
 reportUnnecessaryComparison = "warning"
+reportUnnecessaryContains = "warning"
 reportUnnecessaryIsInstance = "warning"
+reportUntypedBaseClass = "warning"
+reportUntypedClassDecorator = "warning"
+reportUntypedFunctionDecorator = "warning"
+reportUntypedNamedTuple = "warning"
 reportUnusedClass = "warning"
 reportUnusedExpression = "warning"
 reportUnusedFunction = "warning"