Merge pull request #153 from restackio/examples-migrate-to-uv

Migrate to uv

Author: leawn

.gitignore

@@ -4,3 +4,4 @@ venv
 .env
 .vscode
 poetry.lock
+uv.lock

agent_tool/pyproject.toml

@@ -25,4 +25,4 @@ build-backend = "poetry.core.masonry.api"
 # CLI command configuration
 [tool.poetry.scripts]
 dev = "src.services:watch_services"
-services = "src.services:run_services"
+services = "src.services:run_services"

audio_transcript/Dockerfile

@@ -4,19 +4,14 @@ WORKDIR /app
 
 RUN apt-get update && apt-get install -y
 
-RUN pip install poetry
-
-COPY pyproject.toml ./
+COPY pyproject.toml requirements.txt ./
 
 COPY . .
 
-# Configure poetry to not create virtual environment
-RUN poetry config virtualenvs.create false
-
-# Install dependencies
-RUN poetry install --no-interaction --no-ansi
+#Install dependencies
+RUN pip install -e .
 
 # Expose port 80
 EXPOSE 80
 
-CMD poetry run python -m src.services
+CMD ["python", "-m", "src.services"]

audio_transcript/README.md

@@ -18,24 +18,47 @@ docker run -d --pull always --name restack -p 5233:5233 -p 6233:6233 -p 7233:723
 
 ## Start python shell
 
+If using uv:
+
 ```bash
-poetry env use 3.10 && poetry shell
+uv venv && source .venv/bin/activate
 ```
 
-## Install dependencies
+If using poetry:
 
 ```bash
-poetry install
+poetry env use 3.12 && poetry shell
 ```
 
+If using pip:
+
 ```bash
-poetry env info # Optional: copy the interpreter path to use in your IDE (e.g. Cursor, VSCode, etc.)
+python -m venv .venv && source .venv/bin/activate
 ```
 
+## Install dependencies
+
+If using uv:
+
 ```bash
+uv sync
+uv run dev
+```
+
+If using poetry:
+
+```bash
+poetry install
 poetry run dev
 ```
 
+If using pip:
+
+```bash
+pip install -e .
+python -c "from src.services import watch_services; watch_services()"
+```
+
 ## Run workflows
 
 ### from UI
@@ -54,10 +77,24 @@ You can run workflows from the API by using the generated endpoint:
 
 You can run workflows with any client connected to Restack, for example:
 
+If using uv:
+
+```bash
+uv run schedule
+```
+
+If using poetry:
+
 ```bash
 poetry run schedule
 ```
 
+If using pip:
+
+```bash
+python -c "from schedule_workflow import run_schedule_workflow; run_schedule_workflow()"
+```
+
 executes `schedule_workflow.py` which will connect to Restack and execute the `TranscribeTranslateWorkflow` workflow.
 
 ## Deploy on Restack Cloud

audio_transcript/pyproject.toml

@@ -1,27 +1,30 @@
-[tool.poetry]
+[project]
 name = "audio_transcript"
 version = "0.0.1"
 description = "Transcribe audio with OpenAI Whisper and translate the text with OpenAI GPT-4o-mini"
-authors = [
-    "Restack Team <[email protected]>",
-]
+authors = [{ name = "Restack Team", email = "[email protected]" }]
+requires-python = ">=3.10,<4.0"
 readme = "README.md"
-packages = [{include = "src"}]
-
-[tool.poetry.dependencies]
-python = ">=3.10,<4.0"
-pydantic = "^2.10.3"
-python-dotenv = "1.0.1"
-restack-ai = "^0.0.55"
-openai = "^1.59.8"
-watchfiles = "^1.0.4"
-
-[build-system]
-requires = ["poetry-core"]
-build-backend = "poetry.core.masonry.api"
+dependencies = [
+    "pydantic>=2.10.3,<3",
+    "python-dotenv==1.0.1",
+    "restack-ai>=0.0.55,<0.0.56",
+    "openai>=1.59.8,<2",
+    "watchfiles>=1.0.4,<2",
+]
 
-[tool.poetry.scripts]
+[project.scripts]
 dev = "src.services:watch_services"
 services = "src.services:run_services"
 schedule = "schedule_workflow:run_schedule_workflow"
 schedule_failure = "schedule_workflow_failure:run_schedule_workflow_failure"
+
+[tool.hatch.build.targets.sdist]
+include = ["src"]
+
+[tool.hatch.build.targets.wheel]
+include = ["src"]
+
+[build-system]
+requires = ["hatchling"]
+build-backend = "hatchling.build"

audio_transcript/requirements.txt

@@ -0,0 +1,17 @@
+FROM python:3.12-slim
+
+WORKDIR /app
+
+RUN apt-get update && apt-get install -y
+
+COPY pyproject.toml requirements.txt ./
+
+COPY . .
+
+#Install dependencies
+RUN pip install -e .
+
+# Expose port 80
+EXPOSE 80
+
+CMD ["python", "-m", "src.services"]

community/bostondynamics_spot/Dockerfile

@@ -12,72 +12,94 @@ It demonstrates how to control Boston Dynamics Spot robot through a basic workfl
 
 ## Usage
 
-1. Run Restack local engine with Docker:
+## Start Restack
 
-   ```bash
-   docker run -d --pull always --name restack -p 5233:5233 -p 6233:6233 -p 7233:7233 ghcr.io/restackio/restack:main
-   ```
+To start the Restack, use the following Docker command:
 
-2. Open the web UI to see the workflows:
+```bash
+docker run -d --pull always --name restack -p 5233:5233 -p 6233:6233 -p 7233:7233 ghcr.io/restackio/restack:main
+```
 
-   ```bash
-   http://localhost:5233
-   ```
+## Start python shell
 
-3. Clone this repository:
+If using uv:
 
-   ```bash
-   git clone https://github.com/restackio/examples-python
-   cd examples-python/examples/bostondynamics_spot
-   ```
+```bash
+uv venv && source .venv/bin/activate
+```
 
-4. Install dependencies using Poetry:
+If using poetry:
 
-   ```bash
-   poetry env use 3.12
-   ```
+```bash
+poetry env use 3.12 && poetry shell
+```
 
-   ```bash
-   poetry shell
-   ```
+If using pip:
 
-   ```bash
-   poetry install
-   ```
+```bash
+python -m venv .venv && source .venv/bin/activate
+```
 
-   ```bash
-   poetry env info # Optional: copy the interpreter path to use in your IDE (e.g. Cursor, VSCode, etc.)
-   ```
+## Install dependencies
 
-5. Run the services:
+If using uv:
 
-   ```bash
-   poetry run services
-   ```
+```bash
+uv sync
+uv run services
+```
 
-   This will start the Restack service with the defined workflows and functions.
+If using poetry:
 
-6. In a new terminal, schedule the workflow:
+```bash
+poetry install
+poetry run services
+```
 
-   ```bash
-   poetry shell
-   ```
+If using pip:
 
-   ```bash
-   poetry run schedule
-   ```
+```bash
+pip install -e .
+python -c "from src.services import run_services; run_services()"
+```
 
-   This will schedule the `GreetingWorkflow` and print the result.
+## Run workflows
 
-7. Optionally, schedule the workflow to run on a specific calendar or interval:
+### from UI
 
-   ```bash
-   poetry run calendar
-   ```
+You can run workflows from the UI by clicking the "Run" button.
 
-   ```bash
-   poetry run interval
-   ```
+![Run workflows from UI](./ui-screenshot.png)
+
+### from API
+
+You can run workflows from the API by using the generated endpoint:
+
+`POST http://localhost:6233/api/workflows/TranscribeTranslateWorkflow`
+
+### from any client
+
+You can run workflows with any client connected to Restack, for example:
+
+If using uv:
+
+```bash
+uv run schedule
+```
+
+If using poetry:
+
+```bash
+poetry run schedule
+```
+
+If using pip:
+
+```bash
+python -c "from schedule_workflow import run_schedule_workflow; run_schedule_workflow()"
+```
+
+executes `schedule_workflow.py` which will connect to Restack and execute the `TranscribeTranslateWorkflow` workflow.
 
 ## Project Structure
 

community/bostondynamics_spot/README.md

@@ -1,31 +1,31 @@
-# Project metadata
-[tool.poetry]
+[project]
 name = "bostondynamics_spot"
 version = "0.0.1"
 description = "A simple example to get started with the restack-ai SDK"
-authors = [
-    "Restack Team <[email protected]>",
-]
+authors = [{ name = "Restack Team", email = "[email protected]" }]
+requires-python = ">=3.10,<4.0"
 readme = "README.md"
-packages = [{include = "src"}]
-
-[tool.poetry.dependencies]
-python = ">=3.10,<4.0"
-restack-ai = "^0.0.55"
-bosdyn-client = "4.1.0"
-opencv-python = "4.10.0.84"
-setuptools = "75.6.0"
-
-[tool.poetry.dev-dependencies]
-pytest = "6.2"  # Optional: Add if you want to include tests in your example
-
-# Build system configuration
-[build-system]
-requires = ["poetry-core"]
-build-backend = "poetry.core.masonry.api"
+dependencies = [
+    "restack-ai>=0.0.55,<0.0.56",
+    "bosdyn-client==4.1.0",
+    "opencv-python==4.10.0.84",
+    "setuptools==75.6.0",
+]
 
-# CLI command configuration
-[tool.poetry.scripts]
+[project.scripts]
 services = "src.services:run_services"
 spot = "src.spot_services:run_services"
 schedule = "schedule_workflow:run_schedule_workflow"
+
+[dependency-groups]
+dev = ["pytest==6.2"]
+
+[tool.hatch.build.targets.sdist]
+include = ["src"]
+
+[tool.hatch.build.targets.wheel]
+include = ["src"]
+
+[build-system]
+requires = ["hatchling"]
+build-backend = "hatchling.build"