add boilerplates

Author: aboutphilippe

TODO.md

@@ -0,0 +1,7 @@
+# Restack Cloud (Optional)
+
+# RESTACK_ENGINE_ID=<your-engine-id>
+# RESTACK_ENGINE_API_KEY=<your-engine-api-key>
+# RESTACK_ENGINE_API_ADDRESS=<your-engine-api-address>
+# RESTACK_ENGINE_ADDRESS=<your-engine-address>
+# RESTACK_CLOUD_TOKEN=<your-cloud-token>

boilerplates/python/.env.Example

@@ -0,0 +1,6 @@
+__pycache__
+.pytest_cache
+venv
+.env
+.vscode
+poetry.lock

boilerplates/python/.gitignore

@@ -0,0 +1,22 @@
+FROM python:3.12-slim
+
+WORKDIR /app
+
+RUN apt-get update && apt-get install -y
+
+RUN pip install poetry
+
+COPY pyproject.toml ./
+
+COPY . .
+
+# Configure poetry to not create virtual environment
+RUN poetry config virtualenvs.create false
+
+# Install dependencies
+RUN poetry install --no-interaction --no-ansi
+
+# Expose port 80
+EXPOSE 80
+
+CMD poetry run python -m src.services

boilerplates/python/Dockerfile

@@ -0,0 +1,67 @@
+# Restack AI - Quickstart boilerplate Python
+
+This repository contains a quickstart for Restack.
+It demonstrates how to set up a basic workflow and functions.
+
+## Prerequisites
+
+- Docker (for running Restack)
+- Python 3.10 or higher
+
+## Start Restack
+
+To start the Restack, use the following Docker command:
+
+```bash
+docker run -d --pull always --name restack -p 5233:5233 -p 6233:6233 -p 7233:7233 ghcr.io/restackio/restack:main
+```
+
+## Install dependencies and start services
+
+```bash
+poetry env use 3.10
+```
+
+```bash
+poetry shell
+```
+
+```bash
+poetry install
+```
+
+```bash
+poetry env info # Optional: copy the interpreter path to use in your IDE (e.g. Cursor, VSCode, etc.)
+```
+
+```bash
+poetry run dev
+```
+
+## Run workflows
+
+### from UI
+
+You can run workflows from the UI by clicking the "Run" button.
+
+![Run workflows from UI](./screenshot-quickstart.png)
+
+### from API
+
+You can run workflows from the API by using the generated endpoint:
+
+`POST http://localhost:6233/api/workflows/GreetingWorkflow`
+
+### from any client
+
+You can run workflows with any client connected to Restack, for example:
+
+```bash
+poetry run schedule
+```
+
+executes `schedule_workflow.py` which will connect to Restack and execute the `GreetingWorkflow` workflow.
+
+## Deploy on Restack Cloud
+
+To deploy the application on Restack, you can create an account at [https://console.restack.io](https://console.restack.io)

boilerplates/python/README.md

@@ -0,0 +1,29 @@
+# Project metadata
+[tool.poetry]
+name = "quickstart"
+version = "0.0.1"
+description = "A quickstart for Restack"
+authors = [
+    "Restack Team <[email protected]>",
+]
+readme = "README.md"
+packages = [{include = "src"}]
+
+[tool.poetry.dependencies]
+python = ">=3.10,<4.0"
+watchfiles = "^1.0.0"
+pydantic = "^2.10.4"
+
+# Build system configuration
+restack-ai = "^0.0.52"
+[build-system]
+requires = ["poetry-core"]
+build-backend = "poetry.core.masonry.api"
+
+# CLI command configuration
+[tool.poetry.scripts]
+dev = "src.services:watch_services"
+services = "src.services:run_services"
+schedule = "schedule_workflow:run_schedule_workflow"
+interval = "schedule_interval:run_schedule_interval"
+calendar = "schedule_calendar:run_schedule_calendar"

boilerplates/python/pyproject.toml

@@ -0,0 +1,27 @@
+import asyncio
+import time
+from restack_ai import Restack
+from src.workflows.workflow import GreetingWorkflowInput
+async def main():
+
+    client = Restack()
+
+    workflow_id = f"{int(time.time() * 1000)}-GreetingWorkflow"
+    run_id = await client.schedule_workflow(
+        workflow_name="GreetingWorkflow",
+        workflow_id=workflow_id,
+        input=GreetingWorkflowInput(name="Bob")
+    )
+
+    await client.get_workflow_result(
+        workflow_id=workflow_id,
+        run_id=run_id
+    )
+
+    exit(0)
+
+def run_schedule_workflow():
+    asyncio.run(main())
+
+if __name__ == "__main__":
+    run_schedule_workflow()

boilerplates/python/schedule_workflow.py

@@ -0,0 +1,20 @@
+import os
+from restack_ai import Restack
+from restack_ai.restack import CloudConnectionOptions
+from dotenv import load_dotenv  
+# Load environment variables from a .env file
+load_dotenv()
+
+
+engine_id = os.getenv("RESTACK_ENGINE_ID")
+address = os.getenv("RESTACK_ENGINE_ADDRESS")
+api_key = os.getenv("RESTACK_ENGINE_API_KEY")
+api_address = os.getenv("RESTACK_ENGINE_API_ADDRESS")
+
+connection_options = CloudConnectionOptions(
+    engine_id=engine_id,
+    address=address,
+    api_key=api_key,
+    api_address=api_address
+)
+client = Restack(connection_options)

boilerplates/python/src/__init__.py

@@ -0,0 +1,14 @@
+from restack_ai.function import function, log
+from pydantic import BaseModel
+
+class WelcomeInput(BaseModel):
+    name: str
+
+@function.defn()
+async def welcome(input: WelcomeInput) -> str:
+    try:
+        log.info("welcome function started", input=input)
+        return f"Hello, {input.name}!"
+    except Exception as e:
+        log.error("welcome function failed", error=e)
+        raise e

boilerplates/python/src/client.py

@@ -0,0 +1,30 @@
+import asyncio
+import os
+from src.functions.function import welcome
+from src.client import client
+from src.workflows.workflow import GreetingWorkflow
+from watchfiles import run_process
+from restack_ai.restack import ServiceOptions
+import webbrowser
+
+async def main():
+
+    await client.start_service(
+        workflows=[GreetingWorkflow],
+        functions=[welcome]
+    )
+
+def run_services():
+    try:
+        asyncio.run(main())
+    except KeyboardInterrupt:
+        print("Service interrupted by user. Exiting gracefully.")
+
+def watch_services():
+    watch_path = os.getcwd()
+    print(f"Watching {watch_path} and its subdirectories for changes...")
+    webbrowser.open("http://localhost:5233")
+    run_process(watch_path, recursive=True, target=run_services)
+
+if __name__ == "__main__":
+       run_services()

boilerplates/python/src/functions/__init__.py

@@ -0,0 +1,17 @@
+from datetime import timedelta
+from pydantic import BaseModel, Field
+from restack_ai.workflow import workflow, import_functions, log
+with import_functions():
+    from src.functions.function import welcome, WelcomeInput
+
+class GreetingWorkflowInput(BaseModel):
+    name: str = Field(default='Bob')
+
+@workflow.defn()
+class GreetingWorkflow:
+    @workflow.run
+    async def run(self, input: GreetingWorkflowInput):
+        log.info("GreetingWorkflow started")
+        result = await workflow.step(welcome, input=WelcomeInput(name=input.name), start_to_close_timeout=timedelta(seconds=120))
+        log.info("GreetingWorkflow completed", result=result)
+        return result

boilerplates/python/src/functions/function.py

@@ -0,0 +1,7 @@
+# Deploy on Restack Cloud
+
+RESTACK_ENGINE_ID=
+RESTACK_ENGINE_ADDRESS=
+RESTACK_ENGINE_API_KEY=
+
+RESTACK_CLOUD_TOKEN=

boilerplates/python/src/services.py

@@ -0,0 +1,52 @@
+# Build stage
+FROM node:20-bullseye AS builder
+
+WORKDIR /app
+
+# Install pnpm
+RUN npm install -g pnpm
+
+# Copy package files and env file if it exists
+COPY package*.json .env* ./
+
+# Copy package files
+COPY package*.json ./
+
+# Install dependencies including TypeScript
+RUN pnpm install
+RUN pnpm add -D typescript
+
+# Copy source code
+COPY . .
+
+# Build TypeScript code
+RUN pnpm run build
+
+# Production stage
+FROM node:20-bullseye
+
+WORKDIR /app
+
+# Install pnpm
+RUN npm install -g pnpm
+
+# Copy package files and built code
+COPY --from=builder /app/package*.json ./
+COPY --from=builder /app/dist ./dist
+
+# Install production dependencies only
+RUN pnpm install --prod
+
+# Define environment variables
+ARG RESTACK_ENGINE_ID
+ENV RESTACK_ENGINE_ID=${RESTACK_ENGINE_ID}
+
+ARG RESTACK_ENGINE_ADDRESS 
+ENV RESTACK_ENGINE_ADDRESS=${RESTACK_ENGINE_ADDRESS}
+
+ARG RESTACK_ENGINE_API_KEY
+ENV RESTACK_ENGINE_API_KEY=${RESTACK_ENGINE_API_KEY}
+
+EXPOSE 3000
+
+CMD ["node", "dist/services.js"]