[Enhancement] Migrate project environment & packaging from Poetry to uv (#71)

* feat: Migrate project environment & packaging from Poetry to uv

* Updated style of SyGra docs

---------

Co-authored-by: Vipul Mittal <[email protected]>

Author: psriramsnc

.github/dependabot.yml

@@ -0,0 +1,22 @@
+version: 2
+updates:
+  # Keep GitHub Actions up to date
+  - package-ecosystem: github-actions
+    directory: "/"
+    schedule:
+      interval: weekly
+    open-pull-requests-limit: 10
+    labels:
+      - dependencies
+
+  # Update UV-managed Python deps
+  - package-ecosystem: uv
+    directory: "/"
+    schedule:
+      interval: weekly
+    open-pull-requests-limit: 10
+    labels:
+      - dependencies
+    commit-message:
+      prefix: "deps"
+      include: scope

.github/workflows/ci.yml

@@ -12,50 +12,68 @@ permissions:
   pages: write
   id-token: write
 
-env:
-  POETRY_CACHE_DIR: /tmp/poetry_cache
-
 jobs:
 
   build:
     if: github.event_name != 'pull_request' || github.event.pull_request.draft == false
     runs-on: ubuntu-latest
+    env:
+      UV_PROJECT_ENVIRONMENT: .venv
 
     steps:
-      # ---- Cleanup runner disk ----
+      # ---- Disk Cleanup (Safe) ----
       - name: Free disk space
         run: |
           df -h
           sudo rm -rf /usr/local/lib/android || true
           sudo rm -rf /usr/share/dotnet || true
           sudo rm -rf /opt/ghc || true
           sudo rm -rf /usr/local/.ghcup || true
-          sudo rm -rf "$AGENT_TOOLSDIRECTORY" || true
           sudo apt-get clean
           df -h
 
       # ---- Checkout ----
       - uses: actions/checkout@v4
 
-      # ---- Python + Poetry ----
+      # ---- Python setup ----
+      # Pin to an explicit patch version so cached venv is always valid
       - uses: actions/setup-python@v5
+        id: setup-python
         with:
-          python-version: "3.9"
+          python-version: "3.9.25"
 
-      - uses: snok/install-poetry@v1
-        with:
-          virtualenvs-create: true
-          virtualenvs-in-project: true
-          installer-parallel: true
+      # ---- Install uv ----
+      - name: Install uv
+        run: |
+          curl -LsSf https://astral.sh/uv/install.sh | sh
+          echo "$HOME/.local/bin" >> $GITHUB_PATH
+          echo "$HOME/.cargo/bin" >> $GITHUB_PATH
 
-      # ---- Cache Poetry deps only ----
-      - uses: actions/cache@v4
+      # ---- Cache uv global + python installs ----
+      - name: Cache uv global cache
+        uses: actions/cache@v4
         with:
-          path: /tmp/poetry_cache
-          key: poetry-${{ runner.os }}-3.9-${{ hashFiles('**/poetry.lock', '**/pyproject.toml') }}
+          path: |
+            ~/.cache/uv
+            ~/.local/share/uv
+          key: uv-cache-${{ runner.os }}-py${{ steps.setup-python.outputs.python-version }}-${{ hashFiles('**/uv.lock', '**/pyproject.toml') }}
+          restore-keys: |
+            uv-cache-${{ runner.os }}-py${{ steps.setup-python.outputs.python-version }}-
+
+      # ---- Cache project venv ----
+      - name: Cache project .venv
+        uses: actions/cache@v4
+        with:
+          path: .venv
+          key: uv-venv-${{ runner.os }}-py${{ steps.setup-python.outputs.python-version }}-${{ hashFiles('**/uv.lock', '**/pyproject.toml') }}
+          restore-keys: |
+            uv-venv-${{ runner.os }}-py${{ steps.setup-python.outputs.python-version }}-
 
-      # ---- Env Setup ----
-      - run: make setup-dev
+      # ---- Environment Setup ----
+      # Important:
+      # make setup-dev MUST *not* delete .venv — otherwise the cache is pointless.
+      - name: Setup dev environment
+        run: make setup-dev
 
       # ---- FORMAT ----
       - name: Run formatter
@@ -77,7 +95,8 @@ jobs:
       - uses: actions/upload-pages-artifact@v3
         with:
           path: site
-  # Deploy Docs
+
+  # ---- Deploy Docs ----
   deploy_docs:
     if: github.ref == 'refs/heads/main'
     needs: build

.github/workflows/publish.yml

@@ -20,29 +20,37 @@ jobs:
         with:
           python-version: "3.9"
 
-      - name: Install Poetry
-        uses: snok/install-poetry@v1
-        with:
-          virtualenvs-create: true
-          virtualenvs-in-project: true
-          installer-parallel: true
-
-      - name: Cache virtualenv
-        uses: actions/cache@v4
-        with:
-          path: .venv
-          key: venv-${{ runner.os }}-3.9-${{ hashFiles('**/poetry.lock', '**/pyproject.toml') }}
+      - name: Install uv
+        run: |
+          curl -LsSf https://astral.sh/uv/install.sh | sh
+          echo "$HOME/.local/bin" >> $GITHUB_PATH
+          echo "$HOME/.cargo/bin" >> $GITHUB_PATH
 
       - name: Install dependencies
         run: make setup-dev
 
+      - name: Install versioning deps
+        run: |
+          python -m pip install --upgrade pip
+          pip install tomlkit
+
       - name: Set version from GitHub tag
         run: |
           # Extract tag like "v1.2.3" → "1.2.3"
           VERSION=${GITHUB_REF#refs/tags/v}
-          echo "Setting version to $VERSION"
-          # Update pyproject.toml version field
-          sed -i "s/^version = .*/version = \"$VERSION\"/" pyproject.toml
+          echo "Setting [project].version to $VERSION"
+          python - << 'PY'
+          from pathlib import Path
+          from tomlkit import parse, dumps
+          import os
+          version = os.environ.get('VERSION')
+          p = Path('pyproject.toml')
+          doc = parse(p.read_text(encoding='utf-8'))
+          # Update PEP 621 version
+          if 'project' in doc:
+            doc['project']['version'] = version
+          p.write_text(dumps(doc), encoding='utf-8')
+          PY
 
       - name: Build package
         run: make build

.gitignore

@@ -7,8 +7,7 @@ logs/*
 .DS_Store
 .vscode/
 .env
-poetry.lock
 *.egg-info/*
 site/
 build/
-dist/
+dist/

.pre-commit-config.yaml

@@ -45,9 +45,9 @@ repos:
 
   - repo: local
     hooks:
-      - id: mypy-poetry
+      - id: mypy-uv
         name: Type check with mypy
-        entry: poetry run mypy sygra
+        entry: uv run mypy sygra
         language: system
         pass_filenames: false
         stages: [ pre-commit ]
@@ -59,16 +59,11 @@ repos:
         name: Format code with Black
         files: ^(sygra|tests)/.*\.py$
 
-  - repo: https://github.com/python-poetry/poetry
-    rev: 1.7.0
-    hooks:
-      - id: poetry-check
-
   - repo: local
     hooks:
       - id: pytest
         name: Run tests with pytest
-        entry: poetry run pytest -q tests
+        entry: uv run pytest -q tests
         language: system
         pass_filenames: false
         stages: [ pre-commit ]

CONTRIBUTING.md

@@ -30,15 +30,15 @@ We use [pre-commit](https://pre-commit.com/) to keep the codebase consistent. Ho
 ### One-time setup
 
 ```bash
-# Install dependencies (includes pre-commit as a dev dep)
-poetry install
+# Install project dependencies (dev tools included)
+make setup-dev
 
-# Install Git hooks for this repo
-poetry run pre-commit install
-poetry run pre-commit install -t pre-push
+# Install Git hooks for this repo (no need to add pre-commit to deps)
+uvx pre-commit install
+uvx pre-commit install -t pre-push
 
 # (optional) Warm the caches so your first commit is fast
-poetry run pre-commit run --all-files
+uvx pre-commit run --all-files
 ```
 
 #### Why pre-commit?

Makefile

@@ -8,7 +8,7 @@ include check.mk
 # Python interpreter
 PYTHON = python
 PYTEST = pytest
-POETRY = poetry
+UV = uv
 
 ########################################################################################################################
 # DEVELOPMENT ENVIRONMENT
@@ -17,58 +17,58 @@ POETRY = poetry
 .PHONY: setup
 setup: ## Install core dependencies
 	@echo "Installing SyGra core dependencies"
-	$(POETRY) install --no-interaction --no-root --without dev,ui
+	$(UV) sync
 
 .PHONY: setup-all
 setup-all: ## Install core and extra dependencies
 	@echo "Installing SyGra Core and extra dependencies"
-	$(POETRY) install --no-interaction --no-root --without dev
+	$(UV) sync --extra ui
 
 .PHONY: setup-ui
 setup-ui: ## Install development dependencies
 	@echo "Installing SyGra UI dependencies"
-	$(POETRY) install --no-interaction --no-root --without dev
+	$(UV) sync --extra ui
 
 .PHONY: setup-dev
 setup-dev: ## Install development dependencies
 	@echo "Installing SyGra Core, Extra and Development dependencies"
-	$(POETRY) install --no-interaction --no-root
+	$(UV) sync --extra dev --extra ui
 
 ########################################################################################################################
 # TESTING
 ########################################################################################################################
 
 .PHONY: test
 test: ## Run tests
-	$(POETRY) run $(PYTEST)
+	$(UV) run $(PYTEST)
 
 .PHONY: test-verbose
 test-verbose: ## Run tests in verbose mode
-	$(POETRY) run $(PYTEST) -v
+	$(UV) run $(PYTEST) -v
 
 .PHONY: test-coverage
 test-coverage: ## Run tests with coverage
-	$(POETRY) run $(PYTEST) --cov=sygra --cov-report=term --cov-report=xml
+	$(UV) run $(PYTEST) --cov=sygra --cov-report=term --cov-report=xml
 
 ########################################################################################################################
 # DOCUMENTATION
 ########################################################################################################################
 
 .PHONY: docs
 docs: ## Generate documentation
-	$(POETRY) run mkdocs build --strict
+	$(UV) run mkdocs build --strict
 
 .PHONY: docs-serve
 docs-serve: ## Serve documentation locally
-	$(POETRY) run mkdocs serve
+	$(UV) run mkdocs serve
 
 ########################################################################################################################
 # BUILDING & PUBLISHING
 ########################################################################################################################
 
 .PHONY: build
 build: ## Build package
-	$(POETRY) build
+	$(UV) run $(PYTHON) -m build
 
 .PHONY: clean
 clean: ## Clean build artifacts
@@ -84,4 +84,4 @@ clean: ## Clean build artifacts
 ci: check-format check-lint test ## Run CI tasks (format, lint, test)
 
 # Default target
-.DEFAULT_GOAL := help
+.DEFAULT_GOAL := help

README.md

@@ -83,7 +83,7 @@ See full steps in <a href="https://servicenow.github.io/SyGra/installation/">Ins
 git clone [email protected]:ServiceNow/SyGra.git
 
 cd SyGra
-poetry run python main.py --task examples.glaive_code_assistant --num_records=1
+uv run python main.py --task examples.glaive_code_assistant --num_records=1
 ```
 </details>
 
@@ -114,7 +114,7 @@ workflow.run(num_records=1)
 The SyGra architecture is composed of multiple components. The following diagrams illustrate the four primary components and their associated modules.
 
 ### Data Handler
-Data handler is used for reading and writing the data. Currently, it supports following handlers: 
+Data handler is used for reading and writing the data. Currently, it supports following handlers:
  - File handler with various file types like JSON, JSONL, CSV, Parquet, Folder with supported type.
  - Huggingface handler: When reading data from huggingface, it can read the whole dataset and process, or it can stream chunk of data.
  - ServiceNow Handler to connect a ServiceNow instance : Currently it reads or writes into a single table per dataset configuration.