feat: switch from poetry to uv (#561)

* feat: switch from poetry to uv

* chore: update workflows to also use uv instead of poetry.

* chore: update workflows to also use uv instead of poetry.

* chore: update workflows to also use uv instead of poetry.

* chore: update workflows to also use uv instead of poetry.

* chore: update workflows to also use uv instead of poetry.

* chore: update workflows to also use uv instead of poetry.

* chore: update test coverage

* docs: simplify dev guide install

* chore: keeping the same qedc algs from pyproject.toml on main.

* chore: using uv build

Author: vprusso

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

@@ -25,17 +25,16 @@ jobs:
         with:
           python-version: "3.12"
 
-      - name: Install Poetry
-        uses: snok/install-poetry@v1
+      - name: Set up uv
+        uses: astral-sh/setup-uv@v1
         with:
-          virtualenvs-create: true
-          virtualenvs-in-project: true
+          version: "0.8.22"
 
-      - name: Install dependencies
-        run: poetry install --no-interaction --no-root
+      - name: Sync dependencies
+        run: uv sync --group dev --frozen
 
       - name: Build package
-        run: poetry build
+        run: uv build
 
       - name: Publish package distributions to PyPI
         uses: pypa/gh-action-pypi-publish@release/v1

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

@@ -25,17 +25,16 @@ jobs:
         with:
           python-version: "3.12"
 
-      - name: Install Poetry
-        uses: snok/install-poetry@v1
+      - name: Set up uv
+        uses: astral-sh/setup-uv@v1
         with:
-          virtualenvs-create: true
-          virtualenvs-in-project: true
+          version: "0.8.22"
 
-      - name: Install dependencies
-        run: poetry install --no-interaction --no-root
+      - name: Sync dependencies
+        run: uv sync --group dev --frozen
 
       - name: Build package
-        run: poetry build
+        run: uv build
 
       - name: Publish package distributions to TestPyPI
         uses: pypa/gh-action-pypi-publish@release/v1

.github/workflows/test.yml

@@ -1,4 +1,4 @@
-# This workflow will install Python dependencies, run tests, type checking with mypy and lint with Ruff and Poetry.
+# This workflow installs Python dependencies, runs tests, type checks with mypy, and lints with Ruff using uv.
 # It can be tested locally using https://github.com/nektos/act with the command `act push --container-architecture linux/amd64 -j build`
 
 name: Python Tests
@@ -44,35 +44,30 @@ jobs:
       with:
         python-version: ${{ matrix.python-version }}
 
-    - name: Install Poetry
-      run: |
-        python -m pip install --upgrade pip
-        pip install poetry
+    - name: Set up uv
+      uses: astral-sh/setup-uv@v1
+      with:
+        version: "0.8.22"
 
     - name: Initialize and update submodules
       run: |
         git submodule update --init --recursive
 
-    - name: Install project *dependencies only*
+    - name: Sync dependencies
       run: |
-        poetry install --no-root
+        uv sync --group dev --frozen
 
     - name: Lint with Ruff
       run: |
-        poetry run ruff check
+        uv run ruff check
 
     - name: Type checking with MyPy
       # Running mypy with numpy > 2.0 is broken. 
       # This is a fix for stubgen: https://github.com/python/mypy/issues/17396
       run: |
-        poetry run stubgen --no-analysis
-        poetry run mypy
-
-    - name: Install project and CLI command
-      run: |
-        poetry install
+        uv run stubgen --no-analysis
+        uv run mypy
 
     - name: Run tests
       run: |
-        poetry run pytest
-
+        uv run pytest

CONTRIBUTING.md

@@ -4,33 +4,33 @@ Thanks for your interest in improving the project! This guide describes how to g
 
 ## Getting started
 
-1. Install Python 3.12 or newer and [Poetry](https://python-poetry.org/docs/#installation).
+1. Install Python 3.12 or newer and [uv](https://docs.astral.sh/uv/getting-started/installation/).
 2. Clone the repository with submodules:
    ```sh
    git clone --recurse-submodules https://github.com/unitaryfoundation/metriq-gym.git
    cd metriq-gym
    ```
 3. Install dependencies and activate the virtual environment:
    ```sh
-   poetry install
-   poetry shell  # or eval "$(poetry env activate)"
+   uv sync --all-groups
+   source .venv/bin/activate  # or use `uv run` for one-off commands
    ```
 4. Install the pre-commit hooks so linting and type checks run automatically:
    ```sh
-   poetry run pre-commit install
+   uv run pre-commit install
    ```
 
 ## Development workflow
 
-- Use `poetry run mgym --help` to confirm the CLI is wired correctly after changes.
+- Use `uv run mgym --help` to confirm the CLI is wired correctly after changes.
 - Keep provider credentials in a local `.env` copied from `.env.example`; never commit secrets.
-- When touching schemas or benchmark examples, validate them with `poetry run mgym job dispatch ...` using a local simulator before opening a PR.
+- When touching schemas or benchmark examples, validate them with `uv run mgym job dispatch ...` using a local simulator before opening a PR.
 
 ## Coding standards
 
 - Follow the defaults enforced by Ruff: 4-space indentation and 100-character lines.
-- Run `poetry run ruff check --fix` and `poetry run ruff format` before committing.
-- Maintain or extend type hints and verify them with `poetry run mypy`.
+- Run `uv run ruff check --fix` and `uv run ruff format` before committing.
+- Maintain or extend type hints and verify them with `uv run mypy`.
 - Add concise, purposeful docstrings; avoid large dumps of commented-out code.
 - Keep provider-specific logic inside the relevant subpackage (`local/`, `quantinuum/`, `qplatform/`).
 
@@ -39,9 +39,9 @@ Thanks for your interest in improving the project! This guide describes how to g
 Run the relevant test suites prior to submission:
 
 ```sh
-poetry run pytest tests/unit        # fast coverage
-poetry run pytest -m e2e            # CLI workflows (run before merging)
-poetry run pytest                   # full suite when feasible
+uv run pytest tests/unit        # fast coverage
+uv run pytest -m e2e            # CLI workflows (run before merging)
+uv run pytest                   # full suite when feasible
 ```
 
 For features that add new benchmark payloads or alter CLI flows, update fixtures in `jobs/` and document the change in the `CLI Workflows` guide under `docs/source/` if appropriate.

docs/source/developer_guide.rst

@@ -14,7 +14,7 @@ Prerequisites
 Before you begin, ensure you have the following installed:
 
 * `Python <https://www.python.org/downloads/>`_ (version 3.12 or newer)
-* `Poetry <https://python-poetry.org/docs/#installation>`_ for managing dependencies
+* `uv <https://docs.astral.sh/uv/getting-started/installation/>`_ for managing dependencies
 
 Cloning the Repository
 ----------------------
@@ -35,25 +35,15 @@ If you already have a local clone (with or without submodules), keep it current
 Installation
 ------------
 
-Install dependencies into the Poetry-managed virtual environment:
+Install dependencies into the uv-managed virtual environment:
 
 .. code-block:: sh
 
-   poetry install
+   uv sync --all-groups
 
-We recommend working inside an isolated environment. See `Poetry documentation
-<https://python-poetry.org/docs/managing-environments/>`_ for tips on managing virtual environments.
-
-For ``pyenv`` users, the following commands configure Python and install dependencies:
-
-.. code-block:: sh
-
-   pyenv install 3.13
-   pyenv local 3.13
-   poetry install
-   eval $(poetry env activate)
-
-Run all subsequent Python commands inside the activated environment.
+``uv`` reads the Python requirement from ``pyproject.toml`` and provisions a compatible interpreter automatically.
+After ``uv sync`` the project environment lives in ``.venv``; activate it with ``source .venv/bin/activate`` if you
+prefer a shell-based workflow, or continue using ``uv run`` for isolated commands.
 
 Contributing
 ------------
@@ -67,7 +57,7 @@ Run the linter and formatter before each commit. Install the pre-commit hooks ri
 
 .. code-block:: sh
 
-   poetry run pre-commit install
+   uv run pre-commit install
 
 Tests
 -----
@@ -76,19 +66,19 @@ The entire suite of tests can be run with
 
 .. code-block:: sh
 
-   poetry run pytest
+   uv run pytest
 
 Unit tests only can be run with
 
 .. code-block:: sh
 
-   poetry run pytest -m "not e2e"
+   uv run pytest -m "not e2e"
 
 End-to-end tests only can be run with
 
 .. code-block:: sh
 
-   poetry run pytest -m e2e
+   uv run pytest -m e2e
 
 Type Checking
 -------------
@@ -98,7 +88,7 @@ command:
 
 .. code-block:: sh
 
-   poetry run mypy
+   uv run mypy
 
 Documentation
 -------------
@@ -109,7 +99,7 @@ inside the ``docs`` directory:
 .. code-block:: sh
 
    cd docs
-   poetry run make html
+   uv run make html
 
 Open ``_build/html/index.html`` to view the render locally.