switch dependency management from poetry to uv

Author: patrit

.dockerignore

@@ -7,8 +7,7 @@
 !mkdocs.yml
 !Makefile
 !mypy.ini
-!poetry.lock
-!poetry.toml
+!uv.lock
 !pyproject.toml
 !README.md
 

Dockerfile

@@ -2,8 +2,7 @@
 FROM alpine:3.18 AS base
 
 ENV PATH="/app/.venv/bin:$PATH" \
-    PIP_DISABLE_PIP_VERSION_CHECK=1 \
-    PIP_NO_CACHE_DIR=1 \
+    UV_COMPILE_BYTECODE=1 \
     PYTHONFAULTHANDLER=1 \
     PYTHONHASHSEED=random \
     PYTHONUNBUFFERED=1
@@ -13,26 +12,34 @@ RUN apk add --no-cache git python3
 FROM base AS dev
 
 WORKDIR /app
-RUN apk add --no-cache gcc linux-headers musl-dev make poetry python3-dev
-COPY pyproject.toml poetry.lock poetry.toml ./
+RUN apk add --no-cache gcc linux-headers musl-dev make python3-dev
 
 # =========
 FROM dev AS deps
 
-RUN poetry install --only main
+RUN --mount=from=ghcr.io/astral-sh/uv:0.8,source=/uv,target=/bin/uv \
+    --mount=type=cache,target=/root/.cache/uv \
+    --mount=type=bind,source=uv.lock,target=uv.lock \
+    --mount=type=bind,source=pyproject.toml,target=pyproject.toml \
+    uv sync --locked --no-install-project --no-editable
 
 # =========
 FROM deps AS test
 
-RUN poetry install --with test
 COPY . .
-RUN pip install .
+COPY --from=ghcr.io/astral-sh/uv:0.8 /uv /uvx /bin/
+RUN --mount=type=cache,target=/root/.cache/uv \
+    uv sync --locked --group=test
 RUN make checks
 
 # =========
 FROM deps AS docs
 
-RUN poetry install --with docs
+RUN --mount=from=ghcr.io/astral-sh/uv:0.8,source=/uv,target=/bin/uv \
+    --mount=type=cache,target=/root/.cache/uv \
+    --mount=type=bind,source=uv.lock,target=uv.lock \
+    --mount=type=bind,source=pyproject.toml,target=pyproject.toml \
+    uv sync --locked --no-install-project --group=docs
 COPY docs ./docs
 COPY CONTRIBUTING.md mkdocs.yml ./
 RUN mkdocs build
@@ -46,11 +53,14 @@ COPY --from=docs /app/site /site
 FROM deps AS install
 
 COPY . .
-RUN poetry build
-RUN pip install dist/gitopscli-*.whl
+RUN --mount=from=ghcr.io/astral-sh/uv:0.8,source=/uv,target=/bin/uv \
+    --mount=type=cache,target=/root/.cache/uv \
+    --mount=type=bind,source=uv.lock,target=uv.lock \
+    --mount=type=bind,source=pyproject.toml,target=pyproject.toml \
+    uv sync --locked --no-editable
 
 # =========
-FROM base as final
+FROM base AS final
 
 COPY --from=install /app/.venv /app/.venv
 ENTRYPOINT ["gitopscli"]

Makefile

@@ -1,38 +1,38 @@
 init:
-	poetry install
-	pre-commit install
+	uv sync --locked --all-groups
+	uv run pre-commit install
 
 format:
-	poetry run ruff format gitopscli tests
-	poetry run ruff gitopscli tests --fix
+	uv run ruff format gitopscli tests
+	uv run ruff gitopscli tests --fix
 
 format-check:
-	poetry run ruff format gitopscli tests --check
+	uv run ruff format gitopscli tests --check
 
 lint:
-	poetry run ruff gitopscli tests
+	uv run ruff gitopscli tests
 
 mypy:
-	poetry run mypy --install-types --non-interactive .
+	uv run mypy --install-types --non-interactive .
 
 
 test:
-	poetry run pytest -vv -s --typeguard-packages=gitopscli
+	uv run pytest -vv -s --typeguard-packages=gitopscli
 
 coverage:
-	coverage run -m pytest
-	coverage html
-	coverage report
+	uv run coverage run -m pytest
+	uv run coverage html
+	uv run coverage report
 
 checks: format-check lint mypy test
 
 image:
 	DOCKER_BUILDKIT=1 docker build --progress=plain -t gitopscli:latest .
 
 docs:
-	mkdocs serve
+	uv run mkdocs serve
 
 update:
-	poetry lock
+	uv lock
 
 .PHONY: init format format-check lint mypy test coverage checks image docs update

docs/setup.md

@@ -1,8 +1,8 @@
 # Setup
 
-Currently there are two different ways to setup and use the GitOps CLI.
+The GitOps CLI can be used in multiple ways depending on your needs: via Docker, using Astral’s uvx, or by installing it from source for local development.
 
-## Docker
+## Option 1: Use via Docker (Recommended)
 
 The official GitOps CLI Docker image comes with all dependencies pre-installed and ready-to-use. Pull it with:
 ```bash
@@ -13,45 +13,40 @@ Start the CLI and the print the help page with:
 docker run --rm -it baloise/gitopscli --help
 ```
 
-## From Source With Virtualenv
+## Option 2: Run as Tool via uvx
 
-Use this for developement and if you want to prevent dependency clashes with other programs in a user installation.
+Astral's [uvx](https://docs.astral.sh/uv/guides/tools/) allows you to run the CLI without installing it.
 
-Clone the repository and install the GitOps CLI on your machine:
 ```bash
-git clone https://github.com/baloise/gitopscli.git
-cd gitopscli/
-poetry install
-```
-You can now use it from the command line:
-```bash
-poetry run gitopscli --help
-```
-If you don't need the CLI anymore, you can uninstall it with
-```bash
-poetry env remove --all
+uvx https://github.com/baloise/gitopscli.git --help
 ```
 
-Note: if your poetry is not up to date to handle the files you can use a locally updated version.
-Execute the following command in your cloned gitopscli directory to use an updated poetry without changing your system installation:
-```bash
-python3 -m venv .venv
-source .venv/bin/activate
-pip3 install poetry # installs it in the venv
-```
+## Option 3: From Source For Local Development
 
-## From Source Into User Installation
+Use this method if you're contributing to the project or want to develop it on your own.
 
-Clone the repository and install the GitOps CLI on your machine:
+### Prerequisites
+
+Install [uv](https://docs.astral.sh/uv/getting-started/installation/) if it's not yet available.
+
+### Steps
+
+1. Clone the repository:
 ```bash
 git clone https://github.com/baloise/gitopscli.git
-pip3 install gitopscli/
+cd gitopscli/
 ```
-You can now use it from the command line:
+2. Install dependencies:
 ```bash
-gitopscli --help
+uv sync --locked --all-groups
 ```
-If you don't need the CLI anymore, you can uninstall it with
+
+3. Run the CLI:
+```bash
+uv run gitopscli --help
+```
+### Updating uv
+If you're using an older version of uv, you can update it with:
 ```bash
-pip3 uninstall gitopscli
-```
+uv self upgrade
+```