chore: Migrate to uv (#160)

* Move docs * Add uv sources * Resync lockfile * Update github actions * Fix docs gen * Preserve doctree * remove classifiers * Drop 3.8 * Pin Sphinx
gosling-lang · Oct 23, 2024 · 5a9a22a · 5a9a22a
1 parent c88a433
commit 5a9a22a
Show file tree

Hide file tree

Showing 20 changed files with 2,021 additions and 51 deletions.
diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml
@@ -24,13 +24,13 @@ jobs:
       fail-fast: false
       matrix:
         os: [ubuntu-latest]
-        python-version: ["3.8", "3.9", "3.10", "3.11", "3.12"]
+        python-version: ["3.9", "3.10", "3.11", "3.12"]
     steps:
       - uses: actions/checkout@v4
-      - uses: actions/setup-python@v5
+      - uses: astral-sh/setup-uv@v3
         with:
-          python-version: ${{ matrix.python-version }}
+          version: "0.4.x"
       - run: |
-          pip install uv
-          uv pip install --system ".[all,dev]"
-          pytest --ignore gosling/examples --ignore tools/altair --doctest-modules gosling
+          uv run pytest --ignore gosling/examples --ignore tools/altair --doctest-modules gosling
+        env:
+          UV_PYTHON: ${{ matrix.python-version }}
diff --git a/.github/workflows/docs.yml b/.github/workflows/docs.yml
@@ -23,20 +23,19 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       - uses: actions/checkout@v4
-      - uses: actions/setup-python@v5
+      - uses: astral-sh/setup-uv@v3
         with:
-          python-version: "3.12"
+          version: "0.4.x"
       - run: |
-          python -m pip install --upgrade hatch
-          hatch run docs
+          uv run docs/build.py
 
       - name: Setup Pages
         uses: actions/configure-pages@v5
 
       - name: Upload artifact
         uses: actions/upload-pages-artifact@v3
         with:
-          path: './dist'
+          path: './docs/dist'
 
       - name: Deploy to GitHub Pages
         id: deployment

diff --git a/.python-version b/.python-version
@@ -0,0 +1 @@
+3.12
diff --git a/README.md b/README.md
@@ -82,8 +82,12 @@ if you are looking for inspiration.
 
 ## Development
 
-```bash
-pip install -e '.[dev]'
+This project uses [uv](https://github.com/astral-sh/uv) for development.
+
+Run tests with:
+
+```sh
+uv run pytest --ignore gosling/examples --ignore tools/altair --doctest-modules gosling
 ```
 
 The schema bindings (`gosling/schema/`) and docs (`doc/user_guide/API.rst`) are 
@@ -92,7 +96,7 @@ files directly.
 
 ```bash
 # generate gosling/schema/*
-python tools/generate_schema_wrapper.py <tag_name>
+uv run tools/generate_schema_wrapper.py <tag_name>
 ```
 
 ## Release

diff --git a/doc/_static/example.gif → docs/_static/example.gif b/doc/_static/example.gif → docs/_static/example.gif
diff --git a/doc/_static/favicon.ico → docs/_static/favicon.ico b/doc/_static/favicon.ico → docs/_static/favicon.ico
diff --git a/doc/_static/favicon.png → docs/_static/favicon.png b/doc/_static/favicon.png → docs/_static/favicon.png
diff --git a/doc/_static/theme_overrides.css → docs/_static/theme_overrides.css b/doc/_static/theme_overrides.css → docs/_static/theme_overrides.css
diff --git a/doc/_templates/class.rst → docs/_templates/class.rst b/doc/_templates/class.rst → docs/_templates/class.rst
diff --git a/docs/build.py b/docs/build.py
@@ -0,0 +1,33 @@
+# /// script
+# requires-python = ">=3.11"
+# dependencies = [
+#     "furo",
+#     "gosling",
+#     "numpydoc>=1.5",
+#     "sphinx>=6.0",
+# ]
+#
+# [tool.uv.sources]
+# gosling = { path = "../" }
+# ///
+import pathlib
+
+from sphinx.application import Sphinx
+
+SELF_DIR = pathlib.Path(__file__).parent
+
+
+def main():
+    app = Sphinx(
+        srcdir=SELF_DIR,
+        confdir=SELF_DIR,
+        outdir=SELF_DIR / "dist",
+        doctreedir=SELF_DIR / "dist" / ".doctrees",
+        buildername="html",
+    )
+
+    app.build()
+
+
+if __name__ == "__main__":
+    main()
diff --git a/doc/conf.py → docs/conf.py b/doc/conf.py → docs/conf.py
diff --git a/doc/getting_started/installation.rst → docs/getting_started/installation.rst b/doc/getting_started/installation.rst → docs/getting_started/installation.rst
diff --git a/doc/index.rst → docs/index.rst b/doc/index.rst → docs/index.rst
diff --git a/doc/user_guide/API.rst → docs/user_guide/API.rst b/doc/user_guide/API.rst → docs/user_guide/API.rst
diff --git a/doc/user_guide/export.rst → docs/user_guide/export.rst b/doc/user_guide/export.rst → docs/user_guide/export.rst
diff --git a/doc/user_guide/local_data.rst → docs/user_guide/local_data.rst b/doc/user_guide/local_data.rst → docs/user_guide/local_data.rst
diff --git a/doc/user_guide/themes.rst → docs/user_guide/themes.rst b/doc/user_guide/themes.rst → docs/user_guide/themes.rst
diff --git a/pyproject.toml b/pyproject.toml
@@ -5,42 +5,26 @@ build-backend = "hatchling.build"
 [project]
 name = "gosling"
 description = "Python bindings to generate Gosling visualizations"
-authors = [
-    { name = "Trevor Manz", email = "trevor.j.manz@gmail.com" }
-]
+authors = [{ name = "Trevor Manz", email = "trevor.j.manz@gmail.com" }]
+requires-python = ">=3.9"
 license = { text = "MIT" }
 readme = "README.md"
-classifiers = [
-    "Development Status :: 3 - Alpha",
-    "Intended Audience :: Developers",
-    "Programming Language :: Python",
-    "Programming Language :: Python :: 3",
-    "Programming Language :: Python :: 3.8",
-    "Programming Language :: Python :: 3.9",
-    "Programming Language :: Python :: 3.10",
-    "Programming Language :: Python :: 3.11",
-    "Operating System :: OS Independent",
-]
 dynamic = ["version"]
 urls = { homepage = "https://github.com/gosling-lang/gos" }
-dependencies = [
-  "jsonschema>=3.0",
-  "jinja2",
-  "pandas"
-]
+dependencies = ["jsonschema>=3.0", "jinja2", "pandas"]
 
 [project.optional-dependencies]
-all = [
-  "servir>=0.2.1",
-  "gosling-widget>=0.0.2",
+all = ["servir>=0.2.1", "gosling-widget>=0.0.2", "clodius>=0.20.1"]
+
+[tool.uv]
+dev-dependencies = [
   "clodius>=0.20.1",
-]
-dev = [
+  "gosling-widget>=0.0.2",
   "pytest>=6.0",
   "requests>=2.0",
-  "sphinx>=6.0",
-  "numpydoc>=1.5",
-  "furo",
+  "servir>=0.2.1",
+  "setuptools>=75.2.0",
+  "sphinx>=6,<7",
 ]
 
 [tool.hatch.build]
@@ -51,12 +35,3 @@ source = "vcs"
 
 [tool.hatch.build.hooks.vcs]
 version-file = "gosling/_version.py"
-
-[tool.hatch.envs.default]
-features = ["dev", "all"]
-
-[tool.hatch.envs.default.scripts]
-test = "pytest --ignore gosling/examples --ignore tools/altair --doctest-modules gosling"
-clean = "rm -rf doc/_build doc/user_guide/generated/ doc/gallery"
-docs = "sphinx-build -b html doc dist"
-generate-schema-wrapper = "python tools/generate_schema_wrapper.py"
diff --git a/tools/generate_api_docs.py b/tools/generate_api_docs.py
@@ -13,7 +13,7 @@
 import gosling as gos
 import gosling.api as api
 
-API_FILENAME = join(ROOT_DIR, "doc", "user_guide", "API.rst")
+API_FILENAME = join(ROOT_DIR, "docs", "user_guide", "API.rst")
 
 API_TEMPLATE = """\
 .. _API: