Modernise build tooling: switch to uv (#35)

* Add .worktrees/ to .gitignore for git worktree support

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>

* Modernise build tooling: switch to uv for dependency management

- Replace setup.py/setup.cfg/requirements.txt with pyproject.toml
- Add uv to .mise.toml managed tools, remove manual venv config
- Update CI workflow to use astral-sh/setup-uv and uv commands
- Update publish workflow to use uv build/publish with OIDC trusted publishers
- Add AGENTS.md with updated setup/test instructions
- Add uv.lock to .gitignore (library, not application)

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>

* Replace flake8 with ruff; fix uv dev dependency group

- Switch from [project.optional-dependencies] to [dependency-groups]
  so that `uv sync --dev` correctly installs dev dependencies
- Replace flake8 with ruff in the CI workflow
- Remove dead `found_block` variables in resolver.py caught by ruff

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>

---------

Co-authored-by: Claude Sonnet 4.6 <noreply@anthropic.com>

Author: rnorth

.github/workflows/python-package.yml

@@ -1,4 +1,4 @@
-# This workflow will install Python dependencies, run tests and lint with a variety of Python versions
+# This workflow will install Python dependencies, run tests and lint with uv
 # For more information see: https://help.github.com/actions/language-and-framework-guides/using-python-with-github-actions
 
 name: Python package
@@ -20,22 +20,14 @@ jobs:
         python-version: ["3.11"]
 
     steps:
-    - uses: actions/checkout@v2
-    - name: Set up Python ${{ matrix.python-version }}
-      uses: actions/setup-python@v2
+    - uses: actions/checkout@v4
+    - name: Install uv
+      uses: astral-sh/setup-uv@v5
       with:
         python-version: ${{ matrix.python-version }}
     - name: Install dependencies
-      run: |
-        python -m pip install --upgrade pip
-        pip install flake8 pytest
-        if [ -f requirements.txt ]; then pip install -r requirements.txt; fi
-    - name: Lint with flake8
-      run: |
-        # stop the build if there are Python syntax errors or undefined names
-        flake8 codeinclude tests --count --select=E9,F63,F7,F82 --show-source --statistics
-        # exit-zero treats all errors as warnings. The GitHub editor is 127 chars wide
-        flake8 codeinclude tests --count --exit-zero --max-complexity=10 --max-line-length=127 --statistics
+      run: uv sync --dev
+    - name: Lint with ruff
+      run: uv run ruff check codeinclude tests
     - name: Test with pytest
-      run: |
-        pytest
+      run: uv run pytest

.github/workflows/python-publish.yml

@@ -1,4 +1,4 @@
-# This workflows will upload a Python Package using Twine when a release is created
+# This workflow uploads a Python Package using uv when a release is created
 # For more information see: https://help.github.com/en/actions/language-and-framework-guides/using-python-with-github-actions#publishing-to-package-registries
 
 name: Upload Python Package
@@ -11,21 +11,16 @@ jobs:
   deploy:
 
     runs-on: ubuntu-latest
+    permissions:
+      id-token: write
 
     steps:
-    - uses: actions/checkout@v2
-    - name: Set up Python
-      uses: actions/setup-python@v2
+    - uses: actions/checkout@v4
+    - name: Install uv
+      uses: astral-sh/setup-uv@v5
       with:
-        python-version: '3.11'
-    - name: Install dependencies
-      run: |
-        python -m pip install --upgrade pip
-        pip install setuptools wheel twine
-    - name: Build and publish
-      env:
-        TWINE_USERNAME: ${{ secrets.PYPI_USERNAME }}
-        TWINE_PASSWORD: ${{ secrets.PYPI_PASSWORD }}
-      run: |
-        python setup.py sdist bdist_wheel
-        twine upload dist/*
+        python-version: "3.11"
+    - name: Build package
+      run: uv build
+    - name: Publish to PyPI
+      run: uv publish

.gitignore

@@ -1,3 +1,4 @@
+.worktrees/
 *.egg-info/
 .vscode/
 .direnv/
@@ -9,4 +10,5 @@ __pycache__/
 .DS_Store
 .venv/
 build/
-dist/
+dist/
+uv.lock

.mise.toml

@@ -1,5 +1,3 @@
 [tools]
 python = "3.11"
-
-[env]
-_.python.venv = { path = ".venv", create = true }
+uv = "latest"

AGENTS.md

@@ -0,0 +1,38 @@
+# Agent Instructions
+
+## Project
+
+mkdocs-codeinclude-plugin — an MkDocs plugin that includes code snippets into documentation pages.
+
+## Setup
+
+- Use `mise` for tool version management (see `.mise.toml`)
+- `mise install` to install python and uv
+- `uv sync --dev` to install the plugin and dev dependencies
+
+## Testing
+
+- Run tests with `uv run pytest tests/`
+- Always run the full test suite before committing
+
+## Architecture
+
+- `codeinclude/plugin.py` — MkDocs plugin hook that finds `<!--codeinclude-->` blocks in markdown and substitutes code snippets
+- `codeinclude/resolver.py` — selects lines/blocks from source files (by line numbers, block name, or inside_block)
+- `codeinclude/languages.py` — maps file extensions to language identifiers via pygments
+- `tests/codeinclude/` — unit tests; fixtures live in `tests/codeinclude/fixture/`
+
+## Title modes
+
+The plugin supports multiple code block title formats via the `title_mode` config option:
+
+- `pymdownx.tabbed` (default) — `=== "title"` with 4-space indented content
+- `legacy_pymdownx.superfences` — `` ```lang tab="title" ``
+- `mkdocs-material` — `` ```lang title="title" ``
+- `none` — no title
+
+## Releases
+
+- Versioning is handled by `setuptools-scm` (derives version from git tags)
+- Publishing to PyPI is triggered automatically when a GitHub release is published
+- CI runs on Python 3.11

codeinclude/resolver.py

@@ -29,12 +29,10 @@ def select(
     if block:
         i = 0
         delim_count = 0
-        found_block = False
         for line in text.splitlines():
             first_line_of_block = False
             i = i + 1
             if block in line and delim_count <= 0:
-                found_block = True
                 delim_count = 0
                 first_line_of_block = True
                 delim_count += line.count("{")
@@ -52,13 +50,11 @@ def select(
     if inside_block:
         delim_count = 0
         inside_matching = False
-        found_block = False
         for line_number, line in enumerate(text.splitlines(), start=1):
             first_line_of_block = False
 
             # Detect the block beginning
             if inside_block in line and delim_count <= 0:
-                found_block = True
                 delim_count = 0
                 first_line_of_block = True
                 inside_matching = True

pyproject.toml

@@ -0,0 +1,44 @@
+[build-system]
+requires = ["setuptools>=64", "setuptools-scm>=8"]
+build-backend = "setuptools.build_meta"
+
+[project]
+name = "mkdocs-codeinclude-plugin"
+dynamic = ["version"]
+description = "A plugin to include code snippets into mkdocs pages"
+readme = "README.md"
+license = "MIT"
+authors = [
+    { name = "Richard North", email = "rich.north@gmail.com" }
+]
+keywords = ["mkdocs", "python", "markdown", "codeinclude"]
+classifiers = [
+    "Intended Audience :: Developers",
+    "Intended Audience :: Information Technology",
+    "Programming Language :: Python",
+    "Programming Language :: Python :: 3 :: Only",
+    "Programming Language :: Python :: 3.11",
+]
+requires-python = ">=3.11"
+dependencies = [
+    "mkdocs>=1.2",
+    "pygments>=2.9.0",
+]
+
+[project.urls]
+Homepage = "https://github.com/rnorth/mkdocs-codeinclude-plugin"
+
+[dependency-groups]
+dev = [
+    "pytest",
+    "ruff",
+]
+
+[project.entry-points."mkdocs.plugins"]
+codeinclude = "codeinclude.plugin:CodeIncludePlugin"
+
+[tool.setuptools.packages.find]
+where = ["."]
+include = ["codeinclude*"]
+
+[tool.setuptools_scm]