feat: Use uv instead of poetry

uv is faster and simpler than poetry. It solves the issue of managing different python version very conveniently. It is from the creators of ruff. https://github.com/astral-sh/uv
Fraunhofer-AISEC · Nov 28, 2024 · c6d31c4 · c6d31c4
1 parent 5f7811a
commit c6d31c4
Show file tree

Hide file tree

Showing 15 changed files with 1,318 additions and 2,072 deletions.
diff --git a/.github/workflows/docs.yml b/.github/workflows/docs.yml
@@ -24,21 +24,25 @@ jobs:
 
     steps:
     - uses: actions/checkout@v4
-    - uses: actions/setup-python@v5
+
+    - name: Install uv
+      uses: astral-sh/setup-uv@v3
       with:
-        python-version: '3.11'
-    - uses: Gr1N/setup-poetry@v9
-    - uses: actions/cache@v4
+        enable-cache: true
+
+    - name: "Set up Python"
+      uses: actions/setup-python@v5
       with:
-        path: ~/.cache/pypoetry/virtualenvs
-        key: ${{ runner.os }}-poetry-${{ hashFiles('poetry.lock') }}-${{ hashFiles('pyproject.toml') }}
+        python-version-file: ".python-version"
 
-    - name: Install Dependencies
+    - name: Install the project
       run: |
-        poetry install
+        uv sync --all-extras --dev
+
     - name: Invoke sphinx-build
       run: |
-        poetry run make -C docs SPHINXOPTS="-W" html
+        uv run make -C docs SPHINXOPTS="-W" html
+
     - name: Archive webpage
       uses: actions/upload-artifact@v4
       with:
@@ -51,12 +55,6 @@ jobs:
     if: github.ref == 'refs/heads/master'
 
     steps:
-    - uses: Gr1N/setup-poetry@v9
-    - uses: actions/cache@v4
-      with:
-        path: ~/.cache/pypoetry/virtualenvs
-        key: ${{ runner.os }}-poetry-${{ hashFiles('poetry.lock') }}
-
     - name: Download all workflow run artifacts
       uses: actions/download-artifact@v4
 

diff --git a/.github/workflows/linters-win32.yml b/.github/workflows/linters-win32.yml
@@ -29,18 +29,21 @@ jobs:
 
     steps:
     - uses: actions/checkout@v4
-    - uses: actions/setup-python@v5
-      with:
-        python-version: ${{ matrix.python-version }}
-    - uses: Gr1N/setup-poetry@v9
-    - uses: actions/cache@v4
+
+    - name: Install uv
+      uses: astral-sh/setup-uv@v3
       with:
-        path: ~/.cache/pypoetry/virtualenvs
-        key: ${{ runner.os }}-poetry-${{ hashFiles('poetry.lock') }}-${{ hashFiles('pyproject.toml') }}
+        enable-cache: true
 
-    - name: Install Dependencies
+    - name: Set up Python ${{ matrix.python-version }}
       run: |
-        poetry install
+        uv python install ${{ matrix.python-version }}
+        uv python pin ${{ matrix.python-version }}
+
+    - name: Install the project
+      run: |
+        uv sync --all-extras --dev
+
     - name: Run mypy
       run: |
-        poetry run make lint-win32
+        uv run make lint-win32
diff --git a/.github/workflows/linters.yml b/.github/workflows/linters.yml
@@ -13,7 +13,7 @@ on:
   pull_request:
     paths:
     - 'pyproject.toml'
-    - 'poetry.lock'
+    - 'uv.lock'
     - '.github/**'
     - 'src/**'
     - 'tests/**'
@@ -29,27 +29,33 @@ jobs:
 
     steps:
     - uses: actions/checkout@v4
-    - uses: actions/setup-python@v5
-      with:
-        python-version: ${{ matrix.python-version }}
-    - uses: Gr1N/setup-poetry@v9
-    - uses: actions/cache@v4
+
+    - name: Install uv
+      uses: astral-sh/setup-uv@v3
       with:
-        path: ~/.cache/pypoetry/virtualenvs
-        key: ${{ runner.os }}-poetry-${{ hashFiles('poetry.lock') }}-${{ hashFiles('pyproject.toml') }}
+        enable-cache: true
+
+    - name: Set up Python ${{ matrix.python-version }}
+      run: |
+        uv python install ${{ matrix.python-version }}
+        uv python pin ${{ matrix.python-version }}
 
-    - name: Install Dependencies
+    - name: Install the project
       run: |
-        poetry install
+        uv sync --all-extras --dev
+
     - name: Run ruff
       run: |
-        poetry run ruff check src tests
+        uv run ruff check src tests
+
     - name: Run mypy
       run: |
-        poetry run mypy src tests
+        uv run mypy src tests
+
     - name: Run ruff format
       run: |
-        poetry run ruff format --check src tests
+        uv run ruff format --check src tests
+
     - name: Run reuse lint
       run: |
-        poetry run reuse lint
+        uv run reuse lint
diff --git a/.github/workflows/python-publish.yml b/.github/workflows/python-publish.yml
@@ -22,22 +22,23 @@ jobs:
 
     steps:
     - uses: actions/checkout@v4
-    - uses: actions/setup-python@v5
+
+    - name: Install uv
+      uses: astral-sh/setup-uv@v3
       with:
-        python-version: '3.11'
-    - uses: Gr1N/setup-poetry@v9
-    - uses: actions/cache@v4
+        enable-cache: true
+
+    - uses: actions/setup-python@v5
       with:
-        path: ~/.cache/pypoetry/virtualenvs
-        key: ${{ runner.os }}-poetry-${{ hashFiles('poetry.lock') }}-${{ hashFiles('pyproject.toml') }}
+        python-version-file: ".python-version"
 
-    - name: Install Dependencies
+    - name: Install the project
       run: |
-        poetry install
+        uv sync --all-extras
 
     - name: Build package
       run: |
-        poetry build
+        uv build
 
     - name: Publish a Python distribution to PyPI
       uses: pypa/gh-action-pypi-publish@release/v1
diff --git a/.github/workflows/tests.yml b/.github/workflows/tests.yml
@@ -27,21 +27,24 @@ jobs:
 
     steps:
     - uses: actions/checkout@v4
-    - uses: actions/setup-python@v5
-      with:
-        python-version: ${{ matrix.python-version }}
-    - uses: Gr1N/setup-poetry@v9
-    - uses: actions/cache@v4
+
+    - name: Install uv
+      uses: astral-sh/setup-uv@v3
       with:
-        path: ~/.cache/pypoetry/virtualenvs
-        key: ${{ runner.os }}-poetry-${{ hashFiles('poetry.lock') }}-${{ hashFiles('pyproject.toml') }}
+        enable-cache: true
 
-    - name: Install Dependencies
+    - name: Set up Python ${{ matrix.python-version }}
       run: |
-        poetry install
+        uv python install ${{ matrix.python-version }}
+        uv python pin ${{ matrix.python-version }}
+
+    - name: Install the project
+      run: |
+        uv sync --all-extras --dev
+
     - name: Run pytest
       run: |
-        poetry run make pytest
+        uv run make pytest
 
   bats:
     strategy:
@@ -52,14 +55,24 @@ jobs:
 
     steps:
     - uses: actions/checkout@v4
-    - uses: actions/cache@v4
+
+    - name: Install uv
+      uses: astral-sh/setup-uv@v3
       with:
-        path: ~/.cache/pypoetry/virtualenvs
-        key: ${{ runner.os }}-poetry-${{ hashFiles('poetry.lock') }}-${{ hashFiles('pyproject.toml') }}
+        enable-cache: true
+
+    - name: Set up Python ${{ matrix.python-version }}
+      run: |
+        uv python install ${{ matrix.python-version }}
+
     - name: Install Dependencies
       run: |
         apt-get update -y && apt-get install -y bats python3 python3-poetry jq zstd
-        poetry install
+
+    - name: Install the project
+      run: |
+        uv sync --all-extras --dev
+
     - name: Run bats
       run: |
-        poetry run make bats
+        uv run make bats
diff --git a/.github/workflows/upload-artifacts.yml b/.github/workflows/upload-artifacts.yml
diff --git a/.python-version b/.python-version
@@ -0,0 +1 @@
+3.12
diff --git a/poetry.lock.license → .python-version.license b/poetry.lock.license → .python-version.license
diff --git a/Dockerfile b/Dockerfile
@@ -6,10 +6,13 @@ FROM debian:stable
 
 LABEL org.opencontainers.image.authors="stefan.tatschner@aisec.fraunhofer.de"
 
-RUN DEBIAN_FRONTEND=noninteractive apt-get update && apt-get install -y python3 python3-poetry
+RUN DEBIAN_FRONTEND=noninteractive apt-get update && apt-get install -y pipx
 
 WORKDIR /app/gallia
 COPY . .
-RUN ["poetry", "install"]
 
-ENTRYPOINT [ "poetry", "run", "gallia" ]
+ENV PATH="/root/.local/bin:$PATH"
+RUN ["pipx", "install", "uv"]
+RUN ["uv", "sync"]
+
+ENTRYPOINT [ "uv", "run", "gallia" ]
diff --git a/Makefile b/Makefile
@@ -6,7 +6,6 @@
 default:
 	@echo "available targets:"
 	@echo ""
-	@echo " zipapp      build a standalone python zipapp"
 	@echo " fmt         run autoformatters"
 	@echo " lint        run linters"
 	@echo " docs        build docs"
@@ -15,49 +14,40 @@ default:
 	@echo " bats        run bats end to end tests"
 	@echo " clean       delete build artifacts"
 
-.PHONY: zipapp
-TEMPDIR = $(shell mktemp -d)
-zipapp:
-	poetry build -f wheel
-	poetry run python -m pip install --target $(TEMPDIR) gallia dist/*.whl
-	poetry run python -m zipapp -o gallia.pyz -c -p "/usr/bin/env python3" -m "gallia.cli:main" $(TEMPDIR)
-	$(RM) -r $(TEMPDIR)
-
 .PHONY: lint
 lint:
-	mypy src tests
-	ruff check src tests
-	ruff format --check src tests
+	uv run mypy src tests
+	uv run ruff check src tests
+	uv run ruff format --check src tests
 	find tests/bats \( -iname "*.bash" -or -iname "*.bats" -or -iname "*.sh" \) | xargs shellcheck
-	reuse lint
+	uv run reuse lint
 
 .PHONY: lint-win32
 lint-win32:
-	mypy --platform win32 --exclude "gallia\/log\.py" --exclude "hr" src tests
-	ruff check src tests
+	uv run mypy --platform win32 --exclude "gallia\/log\.py" --exclude "hr" src tests
+	uv run ruff check src tests
 
 .PHONY: fmt
 fmt:
-	ruff check --fix-only src tests/pytest
-	ruff format src tests/pytest
+	uv run ruff check --fix-only src tests/pytest
+	uv run ruff format src tests/pytest
 	find tests/bats \( -iname "*.bash" -or -iname "*.bats" -or -iname "*.sh" \) | xargs shfmt -w
 
 .PHONY: docs
 docs:
-	$(MAKE) -C docs html
+	uv run $(MAKE) -C docs html
 
 .PHONY: tests
 tests: pytest bats
 
 .PHONY: pytest
 pytest:
-	python -m pytest -v --cov=$(PWD) --cov-report html tests/pytest
+	uv run python -m pytest -v --cov=$(PWD) --cov-report html tests/pytest
 
 .PHONY: bats
 bats:
-	./tests/bats/run_bats.sh
+	uv run ./tests/bats/run_bats.sh
 
 .PHONY: clean
 clean:
-	$(RM) gallia.pyz
-	$(MAKE) -C docs clean
+	uv run $(MAKE) -C docs clean