Merge pull request #287 from authzed/283-use-uv-for-dep-management-and-building

Use uv for dependency management and packaging

Author: tstirrat15

.github/workflows/lint.yaml

@@ -73,19 +73,6 @@ jobs:
     runs-on: "ubuntu-latest"
     steps:
       - uses: "actions/checkout@v5"
-      - uses: "actions/setup-python@v6"
-        with:
-          python-version: "3.10"
-      - name: "Setup Python Environment"
-        run: "pip install -U pip virtualenv"
-      - name: "Install Dependencies"
-        run: |
-          virtualenv ~/.cache/virtualenv/authzedpy
-          source ~/.cache/virtualenv/authzedpy/bin/activate
-          pip install poetry
-          poetry env info
-          poetry install --only dev
+      - uses: "astral-sh/setup-uv@v6"
       - name: "mypy"
-        run: |
-          source ~/.cache/virtualenv/authzedpy/bin/activate
-          mypy authzed
+        run: "uv run --frozen mypy src/authzed"

.github/workflows/publish-to-pypi.yml

@@ -10,22 +10,17 @@ jobs:
     runs-on: "ubuntu-latest"
     steps:
       - uses: "actions/checkout@v5"
-      - name: "Install Poetry"
-        uses: "snok/install-poetry@v1"
-      - uses: "actions/setup-python@v6"
-        with:
-          python-version: "3.11"
-          cache: 'poetry'
+      - uses: "astral-sh/setup-uv@v6"
       # This gives us a version number without the release prefix
       - name: "Write release version"
         run: |
           VERSION=${GITHUB_REF_NAME#v}
           echo Version: $VERSION
           echo "VERSION=$VERSION" >> $GITHUB_ENV
       - name: "Set the release number in pyproject.toml"
-        run: "poetry version -s $VERSION"
+        run: "uv version $VERSION"
       - name: "Build wheel and source tarball"
-        run: "poetry build"
+        run: "uv build"
       - name: "Publish"
         uses: "pypa/gh-action-pypi-publish@release/v1"
         with:

.github/workflows/test.yaml

@@ -1,6 +1,6 @@
 ---
 name: "Test"
-on:
+on:  # yamllint disable-line rule:truthy
   push:
     branches:
       - "main"
@@ -30,22 +30,12 @@ jobs:
           - "3.13"
     steps:
       - uses: "actions/checkout@v5"
-      - uses: "actions/setup-python@v6"
-        with:
-          python-version: "${{ matrix.python-version }}"
-      - name: "Setup Python Environment"
-        run: "pip install -U pip virtualenv"
-      - name: "Install Dependencies"
-        run: |
-          virtualenv ~/.cache/virtualenv/authzedpy
-          source ~/.cache/virtualenv/authzedpy/bin/activate
-          pip install poetry
-          poetry env info
-          poetry install
       - uses: "authzed/action-spicedb@v1"
         with:
           version: "latest"
-      - name: "Pytest"
-        run: |
-          source ~/.cache/virtualenv/authzedpy/bin/activate
-          pytest -vv
+      - name: "Install the latest version of uv and set the python version"
+        uses: "astral-sh/setup-uv@v6"
+        with:
+          python-version: "${{ matrix.python-version }}"
+      - name: "Run tests"
+        run: "uv run --frozen pytest"

CONTRIBUTING.md

@@ -69,28 +69,27 @@ If you have already authored a commit that is missing the signed-off, you can am
 
 ### Adding and updating dependencies
 
-This project uses [Poetry] for managing dependencies.
-By default, Poetry will create a [virtualenv] for you.
-Optionally, we recommend using [pyenv] if you need to manage Python versions as well as virtualenvs.
+This project uses [uv](https://docs.astral.sh/uv/) for managing dependencies.
 
-Adding a new dependency can be done with `poetry add` command:
+Adding a new dependency can be done with `uv add` command:
 
 ```sh
-poetry add library
+uv add library
 ```
 
-Updating all dependencies can be done with `poetry update` command:
+Updating all dependencies can be done with `uv sync` command:
 
 ```sh
-poetry update
+uv sync
 ```
 
-For more instructions, see the [Poetry documentation].
+Running a command (like `mypy` or `pytest`) can be done with `uv run`:
 
-[poetry]: https://python-poetry.org
-[virtualenv]: https://virtualenv.pypa.io/en/latest/
-[pyenv]: https://github.com/pyenv/pyenv
-[poetry documentation]: https://python-poetry.org/docs/cli
+```sh
+uv run pytest
+```
+
+For more instructions, see the [uv documentation](https://docs.astral.sh/uv/).
 
 ### Updating generated Protobuf code
 
@@ -109,18 +108,20 @@ You can regenerate the code by executing `buf.gen.yaml`:
 
 ### Running the Unit tests
 
-1. `poetry install --with dev`
 1. `docker run -d -p 50051:50051 -p 50052:50052 --entrypoint spicedb quay.io/authzed/spicedb:latest-debug serve-testing` (or pick a specific version of the spicedb server as appropriate)
-1. `poetry run pytest -vv .`
+1. `uv run pytest -vv .`
 
 ### Passing the linters
 
 See the [lint workflow](/.github/workflows/lint.yaml) for updated steps, but it should look something like this:
 
 ```sh
-poetry install --with dev
-poetry shell
-find . -name "*.py" | grep -v "_pb2" | xargs pyflakes
-black .
-find . -name "*.py" | grep -v "_pb2" | xargs isort
+uv run ruff
+```
+
+Alternatively, install `ruf` globally and then run directly:
+
+```sh
+pipx install ruff
+ruff
 ```

buf.gen.yaml

@@ -3,12 +3,12 @@ version: "v2"
 plugins:
   - remote: "buf.build/protocolbuffers/python:v28.3"
     include_imports: true
-    out: "."
+    out: "src"
   - remote: "buf.build/grpc/python:v1.67.1"
-    out: "."
+    out: "src"
   - remote: "buf.build/community/nipunn1313-mypy:v3.6.0"
     include_imports: true
-    out: "."
+    out: "src"
 inputs:
   # NOTE: this references a variant of 1.41.0 that includes the protovalidate code.
   - module: "buf.build/authzed/api:v1.45.0"