Upgrade to uv

Author: palewire

.devcontainer/devcontainer.json

@@ -51,7 +51,7 @@ jobs:
 
       - id: install-python-dependencies
         name: Install Python dependencies
-        run: uv venv && uv pip install . ".[mypy]"
+        run: uv sync --extra mypy
 
       - id: mypy
         name: Run mypy
@@ -81,7 +81,7 @@ jobs:
 
       - id: install-python-dependencies
         name: Install Python dependencies
-        run: uv venv && uv pip install . ".[test]"
+        run: uv sync --extra test
         shell: bash
 
       - id: tests

.github/workflows/continuous-deployment.yaml

@@ -31,7 +31,7 @@ jobs:
 
       - id: install-python-dependencies
         name: Install Python dependencies
-        run: uv venv && uv pip install . ".[docs]"
+        run: uv sync --extra docs
 
       - id: build-sphinx-documentation
         name: Build Sphinx documentation

.github/workflows/docs.yaml

@@ -2,7 +2,7 @@
 # See https://pre-commit.com/hooks.html for more hooks
 repos:
   - repo: 'https://github.com/pre-commit/pre-commit-hooks'
-    rev: v4.6.0
+    rev: v5.0.0
     hooks:
       - id: trailing-whitespace
       - id: end-of-file-fixer
@@ -18,29 +18,29 @@ repos:
       - id: check-merge-conflict
 
   - repo: 'https://github.com/astral-sh/ruff-pre-commit'
-    rev: v0.6.5
+    rev: v0.11.2
     hooks:
       - id: ruff
         args:
           - '--fix'
       - id: ruff-format
 
   - repo: 'https://github.com/asottile/blacken-docs'
-    rev: 1.18.0
+    rev: 1.19.1
     hooks:
       - id: blacken-docs
         additional_dependencies:
           - black
 
   - repo: 'https://github.com/asottile/pyupgrade'
-    rev: v3.17.0
+    rev: v3.19.1
     hooks:
       - id: pyupgrade
         args:
           - '--py37-plus'
 
   - repo: 'https://github.com/pre-commit/mirrors-mypy'
-    rev: v1.11.2
+    rev: v1.15.0
     hooks:
       - id: mypy
         # additional_dependencies:

.pre-commit-config.yaml

@@ -5,19 +5,19 @@ Clone the repository. Move into the directory on your terminal.
 Install dependencies for development.
 
 ```sh
-pipenv sync --dev
+uv sync --all-extras
 ```
 
 Install pre-commit to run a battery of automatic quick fixes against your work.
 
 ```sh
-pipenv run pre-commit install
+uv run pre-commit install
 ```
 
 Run tests.
 
 ```sh
-pipenv run pytest
+uv run pytest
 ```
 
 Before you release your package, be sure to customize the `setup.py` file to fit your project.
@@ -31,13 +31,13 @@ The configuration is stored in the `docs` directory. The default settings in `do
 To build the documentation as a bundle of HTML files, run the following command:
 
 ```zsh
-cd docs && pipenv run make html
+cd docs && uv run make html
 ```
 
 You can launch a preview site with the following command:
 
 ```zsh
-cd docs && pipenv run make livehtml
+cd docs && uv run make livehtml
 ```
 
 The documentation site is automatically built by a [GitHub Actions workflow](https://github.com/palewire/python-open-source-template/blob/main/.github/workflows/docs.yaml) that runs on every push to the repository. If you provide the proper credentials, it will also automatically publish the documentation to an Amazon S3 bucket after a push to the main branch.

CONTRIBUTING.md

@@ -8,15 +8,14 @@
 # sys.path.insert(0, os.path.abspath("../your_source_code"))
 
 project = "your-package-name"
+author = "your-name"
+
 year = datetime.now().year
 copyright = f"{year}"
-author = "your-name"
 
 templates_path = ["_templates"]
 exclude_patterns = ["_build", "Thumbs.db", ".DS_Store"]
 
-# html_theme = "palewire"
-html_baseurl = "/docs/"
 pygments_style = "sphinx"
 
 autodoc_member_order = "bysource"
@@ -34,3 +33,16 @@
     "sphinx.ext.napoleon",
     "sphinxcontrib.mermaid",
 ]
+
+# palewire-sphinx-theme settings
+# html_theme = "palewire"
+# html_sidebars: dict[Any, Any] = {
+#     "**": [
+#         "about.html",
+#         "navigation.html",
+#     ]
+# }
+# html_theme_options: dict[Any, Any] = {
+#     "canonical_url": "https://palewi.re/docs/first-llm-classifier/",
+# }
+# html_baseurl = "/docs/"

Pipfile

@@ -5,10 +5,8 @@ build-backend = "setuptools.build_meta"
 [project]
 name = "your-package-name"
 dynamic = ["version"]
-requires-python = ">=3.9"
-dependencies = [
-    'exceptiongroup; python_version<"3.11"',
-]
+requires-python = "==3.12.*"
+dependencies = []
 authors = [
   { name="Ben Welsh", email="[email protected]" },
 ]
@@ -26,6 +24,11 @@ classifiers = [
 ]
 
 [project.optional-dependencies]
+dev = [
+    "pre-commit",
+    "ipython",
+    "setuptools-scm",
+]
 test = [
     "pytest-runner",
     "pytest-cov",
@@ -38,6 +41,7 @@ docs = [
     "sphinx-autobuild",
     "sphinxcontrib-mermaid",
     "myst-parser",
+    "palewire-sphinx-theme",
 ]
 mypy = [
     "mypy",