Merge pull request #78 from Doist/jacobo/uv

Migrate from poetry to uv

Author: jacobo-doist

.github/workflows/publish.yml

@@ -11,19 +11,25 @@ jobs:
     runs-on: ubuntu-latest
     timeout-minutes: 60
     steps:
-      - uses: actions/checkout@v4
+      - uses: actions/checkout@v5
 
-      - name: Set up Python
-        uses: actions/setup-python@v4
+      - name: Install the latest version of uv
+        uses: astral-sh/setup-uv@v6
         with:
+          version: "latest"
           python-version: "3.9"
 
-      - name: Install dependencies
+      - name: Build package
         run: |
-          python -m pip install poetry
+          uv build
 
-      - name: Build and publish to PyPI
+      - name: Publish to PyPI
         env:
-          POETRY_PYPI_TOKEN_PYPI: ${{ secrets.PYPI_API_TOKEN }}
+          # Possibly not necessary once the repo is a trusted publisher in PyPI
+          UV_PUBLISH_TOKEN: ${{ secrets.PYPI_API_TOKEN }}
         run: |
-          poetry publish --build
+          uv publish
+
+      - name: Check published package
+        run: |
+          uv run --with bitmapist==$(uv version --short) --no-project -- python -c "import bitmapist"

.github/workflows/tests.yml

@@ -16,21 +16,21 @@ jobs:
         python-version: ['3.9', '3.10', '3.11', '3.12', '3.13']
     steps:
       - name: Checkout Repo
-        uses: actions/checkout@v4
+        uses: actions/checkout@v5
 
-      - name: Set up Python
-        uses: actions/setup-python@v4
+      - name: Install the latest version of uv
+        uses: astral-sh/setup-uv@v6
         with:
+          version: "latest"
           python-version: ${{ matrix.python-version }}
 
       - name: Install dependencies
         run: |
-          python -m pip install poetry
-          poetry install
+          uv sync --locked --all-extras --dev
 
       - name: Install redis
         run: |
           sudo apt-get install redis -y
 
       - name: Run tests
-        run: poetry run pytest -vv
+        run: uv run pytest -vv

.pre-commit-config.yaml

@@ -1,4 +1,9 @@
 repos:
+  - repo: https://github.com/astral-sh/uv-pre-commit
+    rev: 0.8.17
+    hooks:
+      - id: uv-lock
+  
   - repo: https://github.com/astral-sh/ruff-pre-commit
     rev: v0.13.0
     hooks:

README.md

@@ -43,6 +43,10 @@ Can be installed very easily via:
 
     $ pip install bitmapist
 
+Or, if you use `uv`:
+
+    $ uv add bitmapist
+
 
 # Ports
 
@@ -331,12 +335,12 @@ Please see our guide [here](./CONTRIBUTING.md)
 
 ## Local Development
 
-We use Poetry for dependency management & packaging.  Please see [here for setup instructions](https://python-poetry.org/docs/#installation).
+We use `uv` for dependency management & packaging.  Please see [here for setup instructions](https://docs.astral.sh/uv/getting-started/).
 
-Once you have Poetry installed, you can run the following to install the dependencies in a virtual environment:
+Once you have `uv` installed, you can run the following to install the dependencies in a virtual environment:
 
 ```bash
-poetry install
+uv sync
 ```
 
 ## Testing
@@ -348,20 +352,20 @@ You can use these environment variables to tell the tests about Redis:
 * `BITMAPIST_REDIS_SERVER_PATH`: Path to the Redis server executable (defaults to the first one in the path or `/usr/bin/redis-server`)
 * `BITMAPIST_REDIS_PORT`: Port number for the Redis server (defaults to 6399)
 
-We use pytest to run unittests which you can run in a poetry shell with
+We use `pytest` to run unit tests, which you can run with:
 
 ```bash
-poetry run pytest
+uv run pytest
 ```
 
 ## Releasing new versions
 
-- Bump version in `pyproject.toml`
+- Bump version in `pyproject.toml` (or use `uv version`)
 - Update the CHANGELOG
 - Commit the changes with a commit message "Version X.X.X"
 - Tag the current commit with `vX.X.X`
 - Create a new release on GitHub named `vX.X.X`
-- GitHub Actions will publish the new version to PIP for you
+- GitHub Actions will publish the new version to PyPI for you
 
 ## Legal