Refactor GitHub workflows to use uv for setup and project installation

tkersey · tkersey · commit 6e23129851ff · 2025-02-27T08:04:50.000-08:00
- Replaced setup from local action to `astral-sh/setup-uv@v5` and `actions/setup-python@v5`.
- Updated Python setup to use `python-version-file: "pyproject.toml"`.
- Changed project installation command to `uv sync --all-extras --dev`.
- Modified test commands to use `uv run` instead of `poetry run`.
- Updated documentation link in README

Signed-off-by: Tim Kersey &lt;t@k-t.im&gt;
diff --git a/.github/workflows/cat-test-examples.yml b/.github/workflows/cat-test-examples.yml
@@ -15,26 +15,32 @@ jobs:
     steps:
       - uses: actions/checkout@v4
 
-      - name: Setup Python and Poetry
-        uses: ./.github/actions/setup-python-poetry
+      - name: Install uv
+        uses: astral-sh/setup-uv@v5
+
+      - name: "Set up Python"
+        uses: actions/setup-python@v5
         with:
-          working-directory: .
+          python-version-file: "pyproject.toml"
+
+      - name: Install the project
+        run: uv sync --all-extras --dev
 
       - name: Authenticate to Google Cloud
         uses: google-github-actions/auth@v2
         with:
           credentials_json: '${{ secrets.GOOGLE_CREDENTIALS }}'
 
       - name: Run Example tests
-        run: poetry run pytest examples/team_recommender
+        run: uv run pytest examples/team_recommender/tests/example_4_gate_on_success_threshold/
         env:
           OPENAI_API_KEY: ${{ secrets.OPENAI_API_KEY }}
 
       - name: Upload artifacts to Google Drive
         if: always()
         run: |
           zip -r test-output-${{ github.run_number }}.zip examples/team_recommender/tests/test_runs
-          poetry run python src/cat_ai/publish_to_gdrive.py test-output-${{ github.run_number }}.zip
+          uv run python src/cat_ai/publish_to_gdrive.py test-output-${{ github.run_number }}.zip
         env:
           GOOGLE_DRIVE_TEST_OUTPUT_FOLDER_ID: ${{ vars.GOOGLE_DRIVE_TEST_OUTPUT_FOLDER_ID }}
 
@@ -49,4 +55,4 @@ jobs:
 #        if: failure()
 #        uses: lhotari/action-upterm@v1
 #        with:
-#          wait-timeout-minutes: 5
+#          wait-timeout-minutes: 5
diff --git a/.github/workflows/python-tests.yml b/.github/workflows/python-tests.yml
@@ -15,10 +15,16 @@ jobs:
     steps:
       - uses: actions/checkout@v4
 
-      - name: Setup Python and Poetry
-        uses: ./.github/actions/setup-python-poetry
+      - name: Install uv
+        uses: astral-sh/setup-uv@v5
+
+      - name: "Set up Python"
+        uses: actions/setup-python@v5
         with:
-          working-directory: .
+          python-version-file: "pyproject.toml"
+
+      - name: Install the project
+        run: uv sync --all-extras --dev
 
       - name: Run unit tests
-        run: poetry run mypy src && poetry run pytest
+        run: uv run mypy src && uv run pytest
diff --git a/README.md b/README.md
@@ -14,25 +14,24 @@ CAT provides the infrastructure needed to:
 ## Example Apps
 
 - [team_recommender - Team Recommender](examples/team_recommender/readme.md)
-- [pythonCatBot - An OpenAI powered Python console chat app](examples/pythonCatBot/README.md)
 
 
 ## Run Tests
 
 ```bash
-poetry run pytest
+uv run pytest
 ```
 
 ## Code Quality
 
 ```bash
-poetry run mypy -p src
+uv run mypy -p src
 ```
 
 ## [Publishing Documentation](https://thisisartium.github.io/continuous-alignment-testing)
 
-The Sphinx based documentation is available at [https://thisisartium.github.io/continuous-alignment-testing](https://thisisartium.github.io/continuous-alignment-testing)
+The Sphinx based documentation is available at [https://thisisartium.github.io/cat-ai](https://thisisartium.github.io/cat-ai)
 
 ## [Wiki](wiki)
 
-- [Archive - To see potentially helpful previous iterations of the code](wiki/ARCHIVE.md)
+- [Archive - To see potentially helpful previous iterations of the code](wiki)
diff --git a/docs/getting-started.md b/docs/getting-started.md
@@ -8,8 +8,12 @@ title: Getting Started
 ## Poetry
 ```sh
 poetry install cat-ai
+
+## UV
+
+uv add cat-ai
 ```
 
 # Driving out non-deterministic projects with CAT
 
-Let's do a step by step journey through the lifecycle of a project to show how and why to use CAT. We will use an example of a project using an LLM and prompt to give recommendations of software teams for a project. The first step will be working with the prompt and LLM in [local development](local-development.md)
+Let's do a step by step journey through the lifecycle of a project to show how and why to use CAT. We will use an example of a project using an LLM and prompt to give recommendations of software teams for a project. The first step will be working with the prompt and LLM in [local development](local-development.md)
diff --git a/examples/team_recommender/readme.md b/examples/team_recommender/readme.md
@@ -1,8 +1,8 @@
 # Local Setup
-- install [poetry](https://python-poetry.org/docs/#installation)
-- run `poetry install`
+- install [uv](https://docs.astral.sh/uv/getting-started/installation)
+- run `uv sync`
 - run `cp .env.example .env`
     - populate your new `.env` file
 
 # Running the tests
-- run `poetry run pytest`
+- run `uv run pytest`
diff --git a/poetry.lock b/poetry.lock
diff --git a/pyproject.toml b/pyproject.toml
@@ -1,38 +1,55 @@
-[tool.poetry]
+[project]
 name = "cat-ai"
 version = "0.0.5-alpha"
 description = "Python client for running CAT tests in a Python codebase"
 authors = [
-  "Mike Gehard <mikegehard@artium.ai>",
-  "Randy Lutcavich <randylutcavich@artium.ai>",
+    { name = "Mike Gehard", email = "mikegehard@artium.ai" },
+    { name = "Randy Lutcavich", email = "randylutcavich@artium.ai" },
 ]
+requires-python = "~=3.13"
 readme = "README.md"
-packages = [{ include = "cat_ai", from = "src" }]
+dependencies = [
+    "pydantic>=2.10.6,<3",
+    "pydrive2>=1.21.3,<2",
+]
+
+[dependency-groups]
+test = [
+    "pytest>=8.3.4,<9",
+    "pytest-asyncio>=0.21.0,<0.22",
+    "mypy>=1.8.0,<2",
+    "black>=24.2.0,<25",
+    "flake8>=7.0.0,<8",
+]
+examples = [
+    "openai>=1.63.2,<2",
+    "python-dotenv>=1.0.1,<2",
+]
+dev = [
+    "sphinx>=8.1.3,<9",
+    "sphinx-rtd-theme>=3.0.2,<4",
+    "sphinx-markdown-builder>=0.6.8,<0.7",
+]
 
-[tool.poetry.dependencies]
-python = "^3.13"
-pydantic = "^2.10.6"
-pydrive2 = "^1.21.3"
+[tool.uv]
+default-groups = [
+    "test",
+    "examples",
+    "dev",
+]
 
-[tool.poetry.group.test.dependencies]
-pytest = "^8.3.4"
-pytest-asyncio = "^0.21.0"
-mypy = "^1.8.0"
-black = "^24.2.0"
-flake8 = "^7.0.0"
+[tool.hatch.build.targets.sdist]
+include = ["src/cat_ai"]
 
-[tool.poetry.group.examples.dependencies]
-openai = "^1.63.2"
-python-dotenv = "^1.0.1"
+[tool.hatch.build.targets.wheel]
+include = ["src/cat_ai"]
 
-[tool.poetry.group.dev.dependencies]
-sphinx = "^8.1.3"
-sphinx-rtd-theme = "^3.0.2"
-sphinx-markdown-builder = "^0.6.8"
+[tool.hatch.build.targets.wheel.sources]
+"src/cat_ai" = "cat_ai"
 
 [build-system]
-requires = ["poetry-core"]
-build-backend = "poetry.core.masonry.api"
+requires = ["hatchling"]
+build-backend = "hatchling.build"
 
 [tool.pytest.ini_options]
 asyncio_mode = "auto"
diff --git a/uv.lock b/uv.lock
