Merge pull request #402 from UKPythonAssociation/feature/uv

Move from pipenv to uv

Author: doismellburning

.github/workflows/pythonapp.yml

@@ -2,24 +2,19 @@ name: Sphinx site
 
 on: [push]
 
+env:
+  UV_LOCKED: 1
+
 jobs:
   build:
 
     runs-on: ubuntu-latest
 
     steps:
     - uses: actions/checkout@v1
-    - name: Set up Python 3.11
-      uses: actions/setup-python@v1
+    - uses: astral-sh/setup-uv@v7
       with:
-        python-version: 3.11
-        cache: "pipenv"
-    - name: Install Pipenv
-      run: |
-        curl https://raw.githubusercontent.com/pypa/pipenv/master/get-pipenv.py | python
-    - name: Install dependencies
-      run: |
-        pipenv install
+        enable-cache: true
     - name: Build
       run: |
-        pipenv run make html dirhtml
+        make html dirhtml

.python-version

@@ -0,0 +1 @@
+3.11

.readthedocs.yaml

@@ -7,14 +7,15 @@ build:
   tools:
     python: "3.11"
   jobs:
-    pre_install:
-      - "pip install pipenv"
-      - "pipenv requirements > requirements.txt"
+    pre_create_environment:
+      - "asdf plugin add uv"
+      - "asdf install uv latest"
+      - "asdf global uv latest"
+    create_environment:
+      - 'uv venv "${READTHEDOCS_VIRTUALENV_PATH}"'
+    install:
+      - 'UV_PROJECT_ENVIRONMENT="${READTHEDOCS_VIRTUALENV_PATH}" uv sync --frozen'
 
 sphinx:
   builder: "dirhtml"
   configuration: "source/conf.py"
-
-python:
-  install:
-    - requirements: "requirements.txt"

Makefile

@@ -10,11 +10,11 @@ BUILDDIR      = build
 
 # Put it first so that "make" without argument is like "make help".
 help:
-	@$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
+	uv run $(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
 
 .PHONY: help Makefile
 
 # Catch-all target: route all unknown targets to Sphinx using the new
 # "make mode" option.  $(O) is meant as a shortcut for $(SPHINXOPTS).
 %: Makefile
-	@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
+	uv run $(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)

Pipfile

@@ -0,0 +1,10 @@
+[project]
+name = "ukpa-internaldocs"
+version = "0.1.0"
+description = "Add your description here"
+readme = "README.md"
+requires-python = ">=3.11"
+dependencies = [
+    "sphinx>=8.2.3",
+    "sphinx-rtd-theme>=3.0.2",
+]