Switch to poetry for dependency management

[willzeng]

We can switch to using poetry for dependency management like in mitiq and in metriq-gym. We can add the linter/formatter as well like in unitaryfund/metriq-gym#22

[jordandsullivan]

@vprusso @cosenal Would you be able to help support the UCC team on this one since you set this up recently for Metriq gym? :)

[vprusso]

Hey @jordandsullivan

I think the general approach here that I would take would be:

1. Remove setup.py and requirements.txt from the root directory of the project.
2. Include a pyproject.toml file in the root directory that looks something like this:

[tool.poetry]
name = "ucc"
version = "0.1.0"
description = "Unitary Compiler Collection: A quantum circuit interface and compiler for multiple quantum frameworks"
authors = ["Jordan Sullivan <jordan@unitary.foundation>", "Misty Wahl", "Nate Stemen"]
license = "GPL-3.0"
readme = "README.md"
repository = "https://github.com/unitaryfund/ucc"
packages = [{ include = "ucc" }]

[tool.poetry.dependencies]
python = ">=3.12"
qiskit = ">=1.3.0"
qiskit-qasm3-import = "0.5.1"
cirq-core = ">=1.4.0"
pytket = ">=1.3.0"
qbraid = ">=0.7.3"
ply = ">=3.11"

[tool.poetry.group.dev.dependencies]
pytest = ">=6.0"
pytest-cov = ">=2.10"

[tool.poetry.group.doc.dependencies]
sphinx = "8.1.3"
myst-parser = ">=0.15"

[tool.poetry.scripts]
ucc = "ucc.__main__:main"

[build-system]
requires = ["poetry-core"]
build-backend = "poetry.core.masonry.api"

3. I would remove VERSION.txt as well as this information should be able to be managed by the pyproject.toml file and is also captured in the _version.py file (but perhaps this can be removed as well and consolidated in one location to minimize version number changes).
4. The Dockerfile will also need to use poetry and not requirements.txt. So something like:

FROM python:3.12-slim

# Install system dependencies (including GNU Parallel)
RUN apt-get update && apt-get install -y parallel curl && rm -rf /var/lib/apt/lists/*

# Install Poetry
ENV POETRY_VERSION=1.8.3
RUN curl -sSL https://install.python-poetry.org | python3 -

# Ensure Poetry is added to PATH
ENV PATH="/root/.local/bin:$PATH"

# Copy the entire project into the container
COPY . /ucc

# Set the working directory to the root of your project
WORKDIR /ucc

# Install dependencies using Poetry
RUN poetry install --no-root --no-interaction --no-ansi

# Install the `ucc` package itself
RUN poetry install --no-interaction --no-ansi

# Ensure the virtual environment is properly activated
ENV VIRTUAL_ENV=/ucc/.venv
ENV PATH="/ucc/.venv/bin:$PATH"

# Show installed package details
RUN poetry show ucc

5. Now the readthedocs.yml file also needs to be changed, but I'm not sure how best to do this. Perhaps there are some templates we can borrow from mitiq?

There might be some minor things I am missing (like updating the README.md to include steps to use poetry instead of pip), but that should be the bulk of it!

Hope that helps, and feel free to reach out if we can help more!

[bachase]

In addition to #208 I also created #209 to demonstrate uv as an alternative. Its not a huge difference at this stage, but uv feels like it has stronger momentum going forward. Can always park for now and revisit.

[willzeng]

I have no preference either way for uv or poetry. Main thing on this issue was to update from just using setup.py. Will let you all on the dev team decide which of those you want to go with.

[willzeng]

Also, one day in and first PR by @bachase! Great :)

[cosenal]

I have no strong preference either, but I would like for us to be consistent across projects in the organization.

Yay to @bachase's first PR first two PRs!

[Misty-W]

+1 for consistency and for the 2 PRs on the first day! ✨

[bachase]

Thanks all -- lets focus on the poetry one for review and release. I don't think its that urgent to change, and it won't be too painful if we decide to change later on.

[bachase]

Closing this based on #208, but will open a followup to introduce the linter/formatter changes