Migrate to uv

Author: amrit110

.github/workflows/code_checks.yml

@@ -1,4 +1,7 @@
 name: code checks
+permissions:
+  contents: read
+  pull-requests: write
 
 on:
   push:
@@ -9,7 +12,7 @@ on:
       - .github/workflows/code_checks.yml
       - .github/workflows/integration_tests.yml
       - '**.py'
-      - poetry.lock
+      - uv.lock
       - pyproject.toml
       - '**.ipynb'
   pull_request:
@@ -19,7 +22,7 @@ on:
       - .pre-commit-config.yaml
       - .github/workflows/code_checks.yml
       - '**.py'
-      - poetry.lock
+      - uv.lock
       - pyproject.toml
       - '**.ipynb'
 
@@ -28,20 +31,21 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       - uses: actions/[email protected]
-      - name: Install and configure Poetry
-        uses: snok/install-poetry@v1
+      - name: Install uv
+        uses: astral-sh/setup-uv@4db96194c378173c656ce18a155ffc14a9fc4355
         with:
-          virtualenvs-create: true
-          virtualenvs-in-project: true
-      - uses: actions/[email protected]
+          # Install a specific version of uv.
+          version: "0.5.21"
+          enable-cache: true
+      - name: "Set up Python"
+        uses: actions/setup-python@42375524e23c412d93fb67b49958b491fce71c38
         with:
-          python-version: '3.10'
-          cache: 'poetry'
+          python-version-file: ".python-version"
+      - name: Install the project
+        run: uv sync --dev
       - name: Install dependencies and check code
         run: |
-          poetry env use '3.10'
           source .venv/bin/activate
-          poetry install --with test --all-extras
           pre-commit run --all-files
       - name: pip-audit (gh-action-pip-audit)
         uses: pypa/[email protected]

.github/workflows/docs.yml

@@ -1,4 +1,7 @@
 name: docs
+permissions:
+  contents: read
+  pull-requests: write
 
 on:
   pull_request:
@@ -14,22 +17,27 @@ jobs:
           submodules: 'true'
           fetch-depth: 0
 
-      - name: Install poetry
-        run: python3 -m pip install --upgrade pip && python3 -m pip install poetry
-
-      - uses: actions/[email protected]
+      - name: Install uv
+        uses: astral-sh/setup-uv@4db96194c378173c656ce18a155ffc14a9fc4355
         with:
-          python-version: '3.10'
-          cache: 'poetry'
+          # Install a specific version of uv.
+          version: "0.5.21"
+          enable-cache: true
 
-      - name: Install dependencies
+      - name: "Set up Python"
+        uses: actions/setup-python@42375524e23c412d93fb67b49958b491fce71c38
+        with:
+          python-version-file: ".python-version"
+      - name: Install the project
+        run: uv sync --dev --group docs
+      - name: Install dependencies and check code
         run: |
-          poetry env use '3.10'
-          poetry install --with docs,test --all-extras
+          source .venv/bin/activate
+          pre-commit run --all-files
 
       - name: Build docs
         run: |
-          source $(poetry env info --path)/bin/activate
+          source .venv/bin/activate
           cd docs
           rm -rf source/reference/api/_autosummary
           if [[ "${{ github.event_name == 'pull_request' && github.event.pull_request.merged == true && contains(github.event.pull_request.labels.*.name, 'release') }}" == "true" ]]; then

.github/workflows/integration_tests.yml

@@ -13,7 +13,7 @@ on:
       - '**.html'
       - '**.jinja'
       - '**.js'
-      - poetry.lock
+      - uv.lock
       - pyproject.toml
       - '**.rst'
       - '**.md'
@@ -30,7 +30,7 @@ on:
       - '**.html'
       - '**.jinja'
       - '**.js'
-      - poetry.lock
+      - uv.lock
       - pyproject.toml
       - '**.rst'
       - '**.md'
@@ -41,20 +41,23 @@ jobs:
     runs-on: [self-hosted, gpu, db, cyclops]
     steps:
       - uses: actions/[email protected]
-      - name: Install poetry
-        run: python3 -m pip install --upgrade pip && python3 -m pip install poetry
-      - uses: actions/[email protected]
+      - name: Install uv
+        uses: astral-sh/setup-uv@4db96194c378173c656ce18a155ffc14a9fc4355
         with:
-          python-version: '3.10'
-          cache: 'poetry'
-      - name: Install dependencies and check code
+          # Install a specific version of uv.
+          version: "0.5.21"
+          enable-cache: true
+      - name: "Set up Python"
+        uses: actions/setup-python@42375524e23c412d93fb67b49958b491fce71c38
+        with:
+          python-version-file: ".python-version"
+      - name: Install project and check code
         run: |
           export PATH=/opt/openmpi-4.1.5/bin:$PATH
           export LD_LIBRARY_PATH=/opt/openmpi-4.1.5/lib:$LD_LIBRARY_PATH
           ompi_info
-          poetry env use '3.10'
-          source $(poetry env info --path)/bin/activate
-          env MPICC=/opt/openmpi-4.1.5/bin/mpicc poetry install --with dev,test --all-extras
+          env MPICC=/opt/openmpi-4.1.5/bin/mpicc uv sync --all-extras --dev --group test
+          source .venv/bin/activate
           mpirun -n 2 python -m pytest --only-mpi
           pytest -m integration_test --cov-report term --cov-report xml:./coverage.xml --cov=cyclops -n auto --dist loadscope
       - name: Upload coverage to Codecov

.github/workflows/package.yml

@@ -29,9 +29,10 @@ jobs:
       - uses: actions/[email protected]
       - name: Install pip
         run: python3 -m pip install --upgrade pip
-      - uses: actions/[email protected]
+      - name: "Set up Python"
+        uses: actions/setup-python@42375524e23c412d93fb67b49958b491fce71c38
         with:
-          python-version: '3.10'
+          python-version-file: ".python-version"
       - name: Install package and test import
         run: |
           pip install -e .

.github/workflows/publish.yml

@@ -1,4 +1,7 @@
 name: publish package
+permissions:
+  contents: read
+  pull-requests: write
 
 on:
   release:
@@ -13,13 +16,25 @@ jobs:
           sudo apt-get update
           sudo apt-get install libcurl4-openssl-dev libssl-dev
       - uses: actions/[email protected]
-      - name: Install poetry
-        run: python3 -m pip install --upgrade pip && python3 -m pip install poetry
-      - uses: actions/[email protected]
+
+      - name: Install uv
+        uses: astral-sh/setup-uv@4db96194c378173c656ce18a155ffc14a9fc4355
+        with:
+          # Install a specific version of uv.
+          version: "0.5.21"
+          enable-cache: true
+
+      - name: "Set up Python"
+        uses: actions/setup-python@42375524e23c412d93fb67b49958b491fce71c38
         with:
-          python-version: '3.10'
+          python-version-file: ".python-version"
+
+      - name: Install the project
+        run: uv sync --all-extras
+
       - name: Build package
-        run: poetry build
+        run: uv build
+
       - name: Publish package
         uses: pypa/gh-action-pypi-publish@76f52bc884231f62b9a034ebfe128415bbaabdfc
         with:

.github/workflows/unit_tests.yml

@@ -11,7 +11,7 @@ on:
       - '**.html'
       - '**.jinja'
       - '**.js'
-      - poetry.lock
+      - uv.lock
       - pyproject.toml
   pull_request:
     branches:
@@ -23,25 +23,28 @@ on:
       - '**.html'
       - '**.jinja'
       - '**.js'
-      - poetry.lock
+      - uv.lock
       - pyproject.toml
 
 jobs:
   build:
     runs-on: ubuntu-latest
     steps:
       - uses: actions/[email protected]
-      - name: Install dependencies, run unit tests and coverage report
-        run: python3 -m pip install --upgrade pip && python3 -m pip install poetry
-      - uses: actions/[email protected]
+      - name: Install uv
+        uses: astral-sh/setup-uv@4db96194c378173c656ce18a155ffc14a9fc4355
         with:
-          python-version: '3.10'
-          cache: 'poetry'
+          # Install a specific version of uv.
+          version: "0.5.21"
+          enable-cache: true
+      - name: "Set up Python"
+        uses: actions/setup-python@42375524e23c412d93fb67b49958b491fce71c38
+        with:
+          python-version-file: ".python-version"
+      - name: Install the project
+        run: uv sync --group test
       - run: |
-          python3 -m pip install --upgrade pip && python3 -m pip install poetry
-          poetry env use '3.10'
-          source $(poetry env info --path)/bin/activate
-          poetry install --with test --all-extras
+          source .venv/bin/activate
           pytest -m "not integration_test" --cov-report term --cov-report xml:./coverage.xml --cov=cyclops -n auto --dist loadscope
       - name: Upload coverage to Codecov
         uses: Wandalen/[email protected]

README.md

@@ -53,29 +53,29 @@ below.
 
 ## 🧑🏿‍💻 Developing
 
-### Using poetry
+### Using uv
 
 The development environment can be set up using
-[poetry](https://python-poetry.org/docs/#installation). Hence, make sure it is
+[uv](https://github.com/astral-sh/uv?tab=readme-ov-file#installation). Hence, make sure it is
 installed and then run:
 
 ```bash
-python3 -m poetry install
-source $(poetry env info --path)/bin/activate
+uv sync
+source .venv/bin/activate
 ```
 
 In order to install dependencies for testing (codestyle, unit tests, integration tests),
 run:
 
 ```bash
-python3 -m poetry install --with test
+uv sync --group test
 ```
 
 API documentation is built using [Sphinx](https://www.sphinx-doc.org/en/master/) and
 can be locally built by:
 
 ```bash
-python3 -m poetry install --with docs
+uv sync --group docs
 cd docs
 make html SPHINXOPTS="-D nbsphinx_allow_errors=True"
 ```
@@ -89,7 +89,7 @@ guidelines.
 
 ## 📚 [Documentation](https://vectorinstitute.github.io/cyclops/)
 
-If you need to build the documentations locally, make sure to install ``Pandoc`` in addition to ``docs`` poetry group.
+If you need to build the documentations locally, make sure to install ``Pandoc`` in addition to ``docs`` dependency group.
 
 
 ## 📓 Notebooks