build: migrate from poetry to uv

Author: owenpearson

.github/workflows/check.yml

@@ -29,33 +29,21 @@ jobs:
         with:
           python-version: ${{ matrix.python-version }}
 
-      - name: Setup poetry
-        uses: abatilo/actions-poetry@v4
+      - name: Install uv
+        uses: astral-sh/setup-uv@v4
         with:
-          poetry-version: '2.1.4'
-
-      - name: Setup a local virtual environment
-        run: |
-          poetry env use ${{ steps.setup-python.outputs.python-path }}
-          poetry run python --version
-          poetry config virtualenvs.create true --local
-          poetry config virtualenvs.in-project true --local
+          enable-cache: true
 
       - uses: actions/cache@v4
         name: Define a cache for the virtual environment based on the dependencies lock file
         id: cache
         with:
           path: ./.venv
-          key: venv-${{ runner.os }}-${{ matrix.python-version }}-${{ hashFiles('poetry.lock') }}
-
-      - name: Ensure cache is healthy
-        if: steps.cache.outputs.cache-hit == 'true'
-        shell: bash
-        run: poetry run pip --version >/dev/null 2>&1 || (echo "Cache is broken, skip it" && rm -rf .venv)
+          key: venv-${{ runner.os }}-${{ matrix.python-version }}-${{ hashFiles('uv.lock') }}
 
       - name: Install dependencies
-        run: poetry install -E crypto
+        run: uv sync --extra crypto --extra dev
       - name: Generate rest sync code and tests
-        run: poetry run unasync
+        run: uv run unasync
       - name: Test with pytest
-        run: poetry run pytest --verbose --tb=short --reruns 3
+        run: uv run pytest --verbose --tb=short --reruns 3

.github/workflows/lint.yml

@@ -19,31 +19,19 @@ jobs:
         with:
           python-version: '3.9'
 
-      - name: Setup poetry
-        uses: abatilo/actions-poetry@v4
+      - name: Install uv
+        uses: astral-sh/setup-uv@v4
         with:
-          poetry-version: '2.1.4'
-
-      - name: Setup a local virtual environment
-        run: |
-          poetry env use ${{ steps.setup-python.outputs.python-path }}
-          poetry run python --version
-          poetry config virtualenvs.create true --local
-          poetry config virtualenvs.in-project true --local
+          enable-cache: true
 
       - uses: actions/cache@v4
         name: Define a cache for the virtual environment based on the dependencies lock file
         id: cache
         with:
           path: ./.venv
-          key: venv-${{ runner.os }}-3.9-${{ hashFiles('poetry.lock') }}
-
-      - name: Ensure cache is healthy
-        if: steps.cache.outputs.cache-hit == 'true'
-        shell: bash
-        run: poetry run pip --version >/dev/null 2>&1 || (echo "Cache is broken, skip it." && rm -rf .venv)
+          key: venv-${{ runner.os }}-3.9-${{ hashFiles('uv.lock') }}
 
       - name: Install dependencies
-        run: poetry install
+        run: uv sync --extra dev
       - name: Lint with flake8
-        run: poetry run flake8
+        run: uv run flake8

.github/workflows/release.yml

@@ -21,36 +21,24 @@ jobs:
         with:
           python-version: 3.12
 
-      - name: Setup poetry
-        uses: abatilo/actions-poetry@v4
+      - name: Install uv
+        uses: astral-sh/setup-uv@v4
         with:
-          poetry-version: '1.8.5'
-
-      - name: Setup a local virtual environment
-        run: |
-          poetry env use ${{ steps.setup-python.outputs.python-path }}
-          poetry run python --version
-          poetry config virtualenvs.create true --local
-          poetry config virtualenvs.in-project true --local
+          enable-cache: true
 
       - uses: actions/cache@v4
         name: Define a cache for the virtual environment based on the dependencies lock file
         id: cache
         with:
           path: ./.venv
-          key: venv-${{ runner.os }}-${{ matrix.python-version }}-${{ hashFiles('poetry.lock') }}
-
-      - name: Ensure cache is healthy
-        if: steps.cache.outputs.cache-hit == 'true'
-        shell: bash
-        run: poetry run pip --version >/dev/null 2>&1 || (echo "Cache is broken, skip it" && rm -rf .venv)
+          key: venv-${{ runner.os }}-3.12-${{ hashFiles('uv.lock') }}
 
       - name: Install dependencies
-        run: poetry install -E crypto
+        run: uv sync --extra crypto --extra dev
       - name: Generate rest sync code and tests
-        run: poetry run unasync
+        run: uv run unasync
       - name: Build a binary wheel and a source tarball
-        run: poetry build
+        run: uv build
       - name: Store the distribution packages
         uses: actions/upload-artifact@v4
         with:

CONTRIBUTING.md

@@ -4,21 +4,21 @@
 
 ### Initialising
 
-ably-python uses [Poetry](https://python-poetry.org/) for packaging and dependency management. Please refer to the [Poetry documentation](https://python-poetry.org/docs/#installation) for up to date instructions on how to install Poetry.
+ably-python uses [uv](https://docs.astral.sh/uv/) for packaging and dependency management. Please refer to the [uv documentation](https://docs.astral.sh/uv/getting-started/installation/) for up to date instructions on how to install uv.
 
 Perform the following operations after cloning the repository contents:
 
 ```shell
 git submodule init
 git submodule update
 # Install the crypto extra if you wish to be able to run all of the tests
-poetry install -E crypto
+uv sync --extra crypto
 ```
 
 ### Running the test suite
 
 ```shell
-poetry run pytest
+uv run pytest
 ```
 
 ## Release Process
@@ -38,8 +38,8 @@ The release process must include the following steps:
 5. Commit this change: `git add CHANGELOG.md && git commit -m "Update change log."`
 6. Push the release branch to GitHub
 7. Create a release PR (ensure you include an SDK Team Engineering Lead and the SDK Team Product Manager as reviewers) and gain approvals for it, then merge that to `main`
-8. Build the synchronous REST client by running `poetry run unasync`
-9. From the `main` branch, run `poetry build && poetry publish` (will require you to have a PyPi API token, see [guide](https://www.digitalocean.com/community/tutorials/how-to-publish-python-packages-to-pypi-using-poetry-on-ubuntu-22-04)) to build and upload this new package to PyPi
+8. Build the synchronous REST client by running `uv run unasync`
+9. From the `main` branch, run `uv build && uv publish` (will require you to have a PyPi API token, see [guide](https://docs.astral.sh/uv/guides/publish/)) to build and upload this new package to PyPi
 10. Create a tag named like `v2.0.1` and push it to GitHub - e.g. `git tag v2.0.1 && git push origin v2.0.1`
 11. Create the release on GitHub including populating the release notes
 12. Update the [Ably Changelog](https://changelog.ably.com/) (via [headwayapp](https://headwayapp.co/)) with these changes