Switch from Poetry to uv (#183)

Because this is an Astral repository ;) and I really want to start testing this in production.
astral-sh · Jun 12, 2024 · afad52b · afad52b
1 parent 21e7d6b
commit afad52b
Show file tree

Hide file tree

Showing 11 changed files with 1,222 additions and 1,205 deletions.
diff --git a/.github/workflows/build.yaml b/.github/workflows/build.yaml
@@ -1,7 +1,6 @@
 name: Build
 
 env:
-  POETRY_VERSION: "1.8.3"
   PYTHON_VERSION: "3.12"
 
 on:
@@ -37,20 +36,21 @@ jobs:
         with:
           python-version: "${{ env.PYTHON_VERSION }}"
 
-      - name: Set up Poetry
+      - name: Set up uv
         run: |
-          pip install poetry==${{ env.POETRY_VERSION }}
+          curl -LsSf https://astral.sh/uv/install.sh | sh
 
       - name: Publish to Test PyPI
         id: build
         env:
-          POETRY_PYPI_TOKEN_TEST_PYPI: ${{ secrets.TEST_PYPI_API_TOKEN }}
+          TWINE_USERNAME: __token__
+          TWINE_PASSWORD: ${{ secrets.TEST_PYPI_API_TOKEN }}
         run: |
           version=$(./scripts/version dev)
           echo "version=$version" >> $GITHUB_OUTPUT
-          poetry version $version
-          poetry config repositories.test-pypi https://test.pypi.org/legacy/
-          poetry publish --build -r test-pypi
+          sed -i -e "s/0.0.0/$version/" pyproject.toml
+          uv tool run -- hatchling build
+          uv tool run -- twine upload -r testpypi dist/*
 
   test-install:
     # We test the install on a clean machine to avoid poetry behavior attempting to
@@ -66,11 +66,9 @@ jobs:
         with:
           python-version: "${{ env.PYTHON_VERSION }}"
 
-      - name: Set up Poetry
+      - name: Set up uv
         run: |
-          pip install poetry==${{ env.POETRY_VERSION }}
-          poetry init --name 'test-project' --no-interaction
-          poetry source add test-pypi https://test.pypi.org/simple/ --priority=explicit
+          curl -LsSf https://astral.sh/uv/install.sh | sh
 
       - name: Wait for package to be available
         run: >
@@ -80,23 +78,25 @@ jobs:
           do sleep 10;
           done
           &&
-          sleep 120
-          # We sleep for an additional 120 seconds as it seems to take a bit longer for
+          sleep 180
+          # We sleep for an additional 180 seconds as it seems to take a bit longer for
           # the package to be consistently available
 
           # Note: The above will not sleep forever due to the job level timeout
 
       - name: Install release from Test PyPI
-        run: >
-          poetry add
-          --source test-pypi
-          packse==${{ needs.build-and-publish.outputs.build-version }}
+        run: |
+          uv pip install \
+            --system \
+            --extra-index-url https://test.pypi.org/simple/ \
+            --index-strategy unsafe-best-match \
+            packse==${{ needs.build-and-publish.outputs.build-version }}
 
       - name: Check release version
         run: |
-          installed=$(poetry run python -c "import pkg_resources; print(pkg_resources.get_distribution('packse').version)")
+          installed=$(python3 -c "import pkg_resources; print(pkg_resources.get_distribution('packse').version)")
           test $installed = ${{ needs.build-and-publish.outputs.build-version }}
 
       - name: Check CLI help
         run: |
-          poetry run -- packse --help
+          packse --help
diff --git a/.github/workflows/check.yaml b/.github/workflows/check.yaml
@@ -1,7 +1,6 @@
 name: Check
 
 env:
-  POETRY_VERSION: "1.8.3"
 
 on:
   pull_request:
@@ -29,32 +28,22 @@ jobs:
     steps:
       - uses: actions/checkout@v4
 
-      - name: Set up Poetry
+      - name: Set up uv
         run: |
-          pipx install poetry==${{ env.POETRY_VERSION }}
+          curl -LsSf https://astral.sh/uv/install.sh | sh
 
       - name: Set up Python ${{ matrix.python-version }}
         uses: actions/setup-python@v5
         with:
           python-version: "${{ matrix.python-version }}"
-          cache: poetry
-
-      - name: Install packages
-        run: |
-          poetry install
 
       - name: Check Python lint
         run: |
-          poetry run -- ruff check . --config pyproject.toml
+          uv tool run -- ruff check . --config pyproject.toml
 
       - name: Check Python formatting
         run: |
-          poetry run -- ruff format --check .  --config pyproject.toml
-
-      - name: Check packaging
-        run: |
-          poetry check
-          poetry lock --check
+          uv tool run -- ruff format --check .  --config pyproject.toml
 
   typos:
     runs-on: ubuntu-latest

diff --git a/.github/workflows/publish.yaml b/.github/workflows/publish.yaml
@@ -4,7 +4,6 @@ env:
   # Enable colored output
   # https://github.com/actions/runner/issues/241
   PY_COLORS: 1
-  POETRY_VERSION: "1.8.3"
 
 permissions:
   id-token: write # Needed for AWS CodeArtifact OIDC
@@ -36,15 +35,14 @@ jobs:
     steps:
       - uses: actions/checkout@v4
 
-      - name: Set up Poetry
+      - name: Set up uv
         run: |
-          pipx install poetry==${{ env.POETRY_VERSION }}
+          curl -LsSf https://astral.sh/uv/install.sh | sh
 
       - name: Set up Python ${{ matrix.python-version }}
         uses: actions/setup-python@v5
         with:
           python-version: ${{ matrix.python-version }}
-          cache: poetry
 
       - name: Install zsh
         run: |
@@ -53,7 +51,7 @@ jobs:
 
       - name: Install packages
         run: |
-          poetry install --extras index
+          uv sync --extra index
 
       - name: Collect scenarios
         run: |
@@ -72,29 +70,29 @@ jobs:
 
       - name: View scenarios
         run: |
-          poetry run packse view $SCENARIOS
+          uv run -- packse view $SCENARIOS
 
       - name: Build scenarios
         run: |
-          poetry run packse build --skip-root --no-hash $SCENARIOS
+          uv run -- packse build --skip-root --no-hash $SCENARIOS
 
       - name: Publish scenarios [local]
         if: github.ref != 'refs/heads/main'
         run: |
           # Start the local index server, do not allow packages from PyPI
-          index_url=$(poetry run packse index up --bg --offline --dist-dir "./published")
+          index_url=$(uv run -- packse index up --bg --offline --dist-dir "./published")
 
           # Publish the packages
-          poetry run packse publish --anonymous --index-url "$index_url" dist/*
+          uv run -- packse publish --anonymous --index-url "$index_url" dist/*
 
           # Shutdown the index server
-          poetry run packse index down
+          uv run -- packse index down
 
       - name: Publish scenarios [gh pages]
         if: github.ref == 'refs/heads/main'
         run: |
           commit=$(./scripts/version parts | jq -r ".short_hash")
-          poetry run packse index build --no-hash --dist-dir ./dist $SCENARIOS
+          uv run -- packse index build --no-hash --dist-dir ./dist $SCENARIOS
 
           git fetch origin gh-pages
           git branch gh-pages FETCH_HEAD

diff --git a/.github/workflows/release.yaml b/.github/workflows/release.yaml
@@ -1,7 +1,6 @@
 name: Release
 
 env:
-  POETRY_VERSION: "1.8.3"
 
 permissions:
   contents: write # Needed for GH pages updates
@@ -29,18 +28,20 @@ jobs:
         with:
           python-version: "3.12"
 
-      - name: Set up Poetry
+      - name: Set up uv
         run: |
-          pip install poetry==${{ env.POETRY_VERSION }}
+          curl -LsSf https://astral.sh/uv/install.sh | sh
 
       # Note: If build and publish steps are ever separated, the version must
       #       be set before building
       - name: Publish package
         env:
-          POETRY_PYPI_TOKEN_PYPI: ${{ secrets.PYPI_API_TOKEN }}
+          TWINE_USERNAME: __token__
+          TWINE_PASSWORD: ${{ secrets.PYPI_API_TOKEN }}
         run: |
-          poetry version "${GITHUB_REF#refs/*/}"
-          poetry publish --build
+          sed -i -e "s/0.0.0/${GITHUB_REF#refs/*/}/" pyproject.toml
+          uv tool run -- hatchling build
+          uv tool run -- twine upload -r testpypi dist/*
 
   release-scenarios:
     name: Publish scenarios
@@ -53,17 +54,17 @@ jobs:
         with:
           python-version: "3.12"
 
-      - name: Set up Poetry
+      - name: Set up uv
         run: |
-          pip install poetry==${{ env.POETRY_VERSION }}
+          curl -LsSf https://astral.sh/uv/install.sh | sh
 
       - name: Install packages
         run: |
-          poetry install --all-extras
+          uv sync --all-extras
 
       - name: Publish scenarios to GitHub Pages
         run: |
-          poetry run packse index build --no-hash scenarios/
+          uv run -- packse index build --no-hash scenarios/
 
           git fetch origin gh-pages
           git branch gh-pages FETCH_HEAD

diff --git a/.github/workflows/test.yaml b/.github/workflows/test.yaml
@@ -5,7 +5,6 @@ env:
   # https://github.com/pytest-dev/pytest/issues/7443
   # https://github.com/actions/runner/issues/241
   PY_COLORS: 1
-  POETRY_VERSION: "1.8.3"
 
 on:
   pull_request:
@@ -41,20 +40,19 @@ jobs:
     steps:
       - uses: actions/checkout@v4
 
-      - name: Set up Poetry
+      - name: Set up uv
         run: |
-          pipx install poetry==${{ env.POETRY_VERSION }}
+          curl -LsSf https://astral.sh/uv/install.sh | sh
 
       - name: Set up Python ${{ matrix.python-version }}
         uses: actions/setup-python@v5
         with:
           python-version: ${{ matrix.python-version }}
-          cache: poetry
 
       - name: Install packages
         run: |
-          poetry install --all-extras
+          uv sync --all-extras --dev
 
       - name: Run tests
         run: |
-          poetry run -- pytest tests
+          uv run -- pytest tests
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -2,12 +2,28 @@
 
 This document outlines a few tips for contributing to packse.
 
+## Getting started
+
+packse uses `uv`'s preview interface:
+
+Install the project:
+
+```
+uv sync
+```
+
+Check that packse is available
+
+```
+uv run -- packse --help
+```
+
 ## Running tests
 
 packse uses `pytest`:
 
 ```
-poetry run pytest
+uv run -- pytest
 ```
 
 ## Updating snapshots
@@ -17,7 +33,7 @@ you should examine whether the changes are correct. If so, you can re-run the
 tests with the `--snapshot-update` flag:
 
 ```
-poetry run pytest --snapshot-update
+uv run -- pytest --snapshot-update
 ```
 
 And then commit the results. In at least some cases, this may commit a snapshot

diff --git a/README.md b/README.md
@@ -4,15 +4,13 @@ Python packaging scenarios.
 
 ## Installation
 
-Only a local installation is supported at this time:
+Install from PyPI:
 
 ```bash
-poetry install
+uv pip install packse
 ```
-Once installed, the `packse` command-line interface will be available.
 
-Depending on your Poetry configuration, you may need to use `poetry run packse` instead or activate Poetry's
-virtual environment.
+Once installed, the `packse` command-line interface will be available.
 
 ## Usage
 
@@ -161,9 +159,10 @@ packse publish dist/example-cd797223 --index-url http://localhost:3141 --anonymo
 Packages can also be published to the index by placing their distributions in the configured `--dist-dir`. This defaults
 to `./dist` which is also the default location used in `packse build`.
 
-By default, the  index will fallback to PyPI for missing packages. To test in isolation, use the `--offline` flag.
+By default, the index will fallback to PyPI for missing packages. To test in isolation, use the `--offline` flag.
 
 To stop an index running in the background use `packse index down`:
+
 ```
 packse index down
 ```