Switch form Pipenv to uv

Author: 31ch

.devcontainer/Dockerfile

@@ -7,6 +7,12 @@ FROM mcr.microsoft.com/devcontainers/python:1-3.12-bookworm
 #       <your-package-list-here> \
 #    && apt-get autoremove -y && apt-get clean -y && rm -rf /var/lib/apt/lists/*
 
-# Install pipenv dependencies
-COPY Pipfile Pipfile.lock /tmp/
-RUN cd /tmp && pipenv install --system --dev
+# Install UV / UVX
+COPY --from=ghcr.io/astral-sh/uv:latest /uv /uvx /bin/
+ENV UV_COMPILE_BYTECODE=1
+ENV UV_LINK_MODE=copy
+
+# Install project dependencies
+RUN --mount=type=bind,source=pyproject.toml,target=pyproject.toml \
+    --mount=type=bind,source=uv.lock,target=uv.lock \
+    uv sync --frozen --no-install-project --all-extras

.devcontainer/devcontainer.json

@@ -14,7 +14,7 @@
 	// Use 'forwardPorts' to make a list of ports inside the container available locally.
 	// "forwardPorts": [],
 	// Use 'postCreateCommand' to run commands after the container is created.
-	"postCreateCommand": "pip install -e ."
+	"postCreateCommand": "uv sync"
 	// Configure tool-specific properties.
 	// "customizations": {},
 	// Uncomment to connect as root instead. More info: https://aka.ms/dev-containers-non-root.

.github/workflows/project-build-test.yml

@@ -42,9 +42,9 @@ jobs:
     steps:
       - name: Checkout code
         uses: actions/checkout@v4
-      - name: Build package
+      - name: Build Python package
         run: ./tools/build-package.sh
-      - name: Upload python package
+      - name: Upload Python package
         uses: actions/upload-artifact@v4
         with:
           name: python-package
@@ -77,7 +77,7 @@ jobs:
     steps:
       - name: Checkout code
         uses: actions/checkout@v4
-      - name: Run pytest
+      - name: Run tests
         run: ./tools/test-package.sh
       - name: Upload test results
         uses: actions/upload-artifact@v4

.gitignore

@@ -1,5 +1,8 @@
 __pycache__
 .coverage
+.mypy_cache
+.pytest_cache
+.venv
 *.egg-info
 _build
 build

Pipfile

@@ -20,13 +20,12 @@ Commands:
 
 The Python package is based on the following toolchain:
 
-* [Pipenv](https://pipenv.pypa.io/en/latest/) for dependencies and virtual environment
+* [uv](https://docs.astral.sh/uv/) for dependencies and virtual environment
 * [Sphinx](https://www.sphinx-doc.org/en/master/) for documentation
 * [Flake8](https://flake8.pycqa.org/en/latest/) for style guide enforcement
 * [mypy](https://mypy-lang.org/) for static type checking
 * [Pylint](https://www.pylint.org/) for static code analysis
 * [pytest](https://docs.pytest.org/en/stable/) for test creation and execution
-* [Twine](https://twine.readthedocs.io/en/stable/) for package deployment
 
 
 ## Directory structure
@@ -43,64 +42,52 @@ The Python package is based on the following toolchain:
 
 ## Build, test and deploy instructions
 
-Create and activate the Python virtual environment:
+All steps required to build, test or deploy the Python package are wrapped in separate shell scripts.
 
-```bash
-pipenv sync --dev # setup virtual environment including development dependencies
-pipenv shell      # activate virtual environment
-```
-
-Note: the Python virtual environment can be removed using `pipenv --rm`.
-
-**IMPORTANT:** all of the following commands have to be executed within the Python virtual environment!
+Check the content of the corresponding scripts for details.
 
 ### Build documentation
 
-Build the Sphinx documentation: `./tools/build-docs.sh`
+Build the Sphinx documentation:
 
 ```bash
-pip install -e .  # package installation is required for Git version
-cd docs
-make html
+./tools/build-docs.sh
 ```
 
 ### Build Python package
 
-Build the Python package: `./tools/build-package.sh`
+Build the Python package:
 
 ```bash
-python -m build --wheel
+./tools/build-package.sh
 ```
 
 ### Run Python linters
 
-Run static code analysis: `./tools/lint-package.sh`
+Run static code analysis:
 
 ```bash
-mkdir -p build
-flake8 src/python_training_project --format=pylint > build/flake8.txt
-pylint src/python_training_project --msg-template="{path}:{line}: [{msg_id}, {obj}] {msg} ({symbol})" > build/pylint.txt
-mypy src/python_training_project > build/mypy.txt
+./tools/lint-package.sh
 ```
 
 ### Run Python tests
 
-Run Python tests: `./tools/test-package.sh`
+Run Python tests:
 
 ```bash
-pip install -e .  # package installation is required for path resolution
-mkdir -p build
-pytest
+./tools/test-package.sh
 ```
 
 ### Deploy Python package
 
-Deploy the Python package: `./tools/deploy-package.sh`
+Make sure the set the following environment variables before calling the deployment script:
+
+* `UV_PUBLISH_URL`
+* `UV_PUBLISH_USERNAME`
+* `UV_PUBLISH_PASSWORD`
+
+Deploy the Python package:
 
 ```bash
-# Make sure to set the following environment variables
-# TWINE_REPOSITORY_URL
-# TWINE_USERNAME
-# TWINE_PASSWORD
-twine upload dist/*
+./tools/deploy-package.sh
 ```

Pipfile.lock

@@ -25,6 +25,20 @@ dependencies = [
 ]
 dynamic = ["version"]
 
+[project.optional-dependencies]
+dev = [
+    "coverage",
+    "flake8",
+    "mypy",
+    "myst-parser",
+    "pylint",
+    "pytest",
+    "pytest-cov",
+    "pytest-mock",
+    "sphinx",
+    "sphinx-rtd-theme",
+]
+
 [project.urls]
 "Homepage" = "https://github.com/devminds-ch/project-python"
 "Bug Tracker" = "https://github.com/devminds-ch/project-python/issues"

README.md

@@ -6,9 +6,8 @@ REPO_ROOT=$(git rev-parse --show-toplevel)
 pushd "${REPO_ROOT}" 2>&1 > /dev/null
 
 echo "Building documentation..."
-pip install -e . # required for python_training_project.version
 mkdir -p build
 cd docs
-make html
+uv run --all-extras make html
 
 popd 2>&1 > /dev/null

pyproject.toml

@@ -6,6 +6,6 @@ REPO_ROOT=$(git rev-parse --show-toplevel)
 pushd "${REPO_ROOT}" 2>&1 > /dev/null
 
 echo "Building package..."
-python -m build --wheel
+uv build
 
 popd 2>&1 > /dev/null