Skip to content

Commit ac6e6f2

Browse files
committed
Update readmes
1 parent e4b141b commit ac6e6f2

File tree

22 files changed

+1194
-584
lines changed

22 files changed

+1194
-584
lines changed

audio_transcript/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -80,7 +80,7 @@ You can run workflows with any client connected to Restack, for example:
8080
If using uv:
8181

8282
```bash
83-
poetry run schedule
83+
uv run schedule
8484
```
8585

8686
If using poetry:

community/bostondynamics_spot/README.md

Lines changed: 68 additions & 46 deletions
Original file line numberDiff line numberDiff line change
@@ -12,72 +12,94 @@ It demonstrates how to control Boston Dynamics Spot robot through a basic workfl
1212

1313
## Usage
1414

15-
1. Run Restack local engine with Docker:
15+
## Start Restack
1616

17-
```bash
18-
docker run -d --pull always --name restack -p 5233:5233 -p 6233:6233 -p 7233:7233 ghcr.io/restackio/restack:main
19-
```
17+
To start the Restack, use the following Docker command:
2018

21-
2. Open the web UI to see the workflows:
19+
```bash
20+
docker run -d --pull always --name restack -p 5233:5233 -p 6233:6233 -p 7233:7233 ghcr.io/restackio/restack:main
21+
```
2222

23-
```bash
24-
http://localhost:5233
25-
```
23+
## Start python shell
2624

27-
3. Clone this repository:
25+
If using uv:
2826

29-
```bash
30-
git clone https://github.com/restackio/examples-python
31-
cd examples-python/examples/bostondynamics_spot
32-
```
27+
```bash
28+
uv venv && source .venv/bin/activate
29+
```
3330

34-
4. Install dependencies using Poetry:
31+
If using poetry:
3532

36-
```bash
37-
poetry env use 3.12
38-
```
33+
```bash
34+
poetry env use 3.12 && poetry shell
35+
```
3936

40-
```bash
41-
poetry shell
42-
```
37+
If using pip:
4338

44-
```bash
45-
poetry install
46-
```
39+
```bash
40+
python -m venv .venv && source .venv/bin/activate
41+
```
4742

48-
```bash
49-
poetry env info # Optional: copy the interpreter path to use in your IDE (e.g. Cursor, VSCode, etc.)
50-
```
43+
## Install dependencies
5144

52-
5. Run the services:
45+
If using uv:
5346

54-
```bash
55-
poetry run services
56-
```
47+
```bash
48+
uv sync
49+
uv run services
50+
```
5751

58-
This will start the Restack service with the defined workflows and functions.
52+
If using poetry:
5953

60-
6. In a new terminal, schedule the workflow:
54+
```bash
55+
poetry install
56+
poetry run services
57+
```
6158

62-
```bash
63-
poetry shell
64-
```
59+
If using pip:
6560

66-
```bash
67-
poetry run schedule
68-
```
61+
```bash
62+
pip install -e .
63+
python -c "from src.services import run_services; run_services()"
64+
```
6965

70-
This will schedule the `GreetingWorkflow` and print the result.
66+
## Run workflows
7167

72-
7. Optionally, schedule the workflow to run on a specific calendar or interval:
68+
### from UI
7369

74-
```bash
75-
poetry run calendar
76-
```
70+
You can run workflows from the UI by clicking the "Run" button.
7771

78-
```bash
79-
poetry run interval
80-
```
72+
![Run workflows from UI](./ui-screenshot.png)
73+
74+
### from API
75+
76+
You can run workflows from the API by using the generated endpoint:
77+
78+
`POST http://localhost:6233/api/workflows/TranscribeTranslateWorkflow`
79+
80+
### from any client
81+
82+
You can run workflows with any client connected to Restack, for example:
83+
84+
If using uv:
85+
86+
```bash
87+
uv run schedule
88+
```
89+
90+
If using poetry:
91+
92+
```bash
93+
poetry run schedule
94+
```
95+
96+
If using pip:
97+
98+
```bash
99+
python -c "from schedule_workflow import run_schedule_workflow; run_schedule_workflow()"
100+
```
101+
102+
executes `schedule_workflow.py` which will connect to Restack and execute the `TranscribeTranslateWorkflow` workflow.
81103

82104
## Project Structure
83105

community/e2b/README.md

Lines changed: 43 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -20,34 +20,55 @@ This repository demonstrates how to use [E2B](https://e2b.dev) for code executio
2020

2121
## Start Restack
2222

23-
To start Restack locally, use the following Docker command:
23+
To start the Restack, use the following Docker command:
2424

2525
```bash
2626
docker run -d --pull always --name restack -p 5233:5233 -p 6233:6233 -p 7233:7233 ghcr.io/restackio/restack:main
2727
```
2828

29-
## Setup Python Environment
29+
## Start python shell
30+
31+
If using uv:
3032

3133
```bash
32-
poetry env use 3.10 && poetry shell
34+
uv venv && source .venv/bin/activate
3335
```
3436

35-
## Install Dependencies
37+
If using poetry:
3638

3739
```bash
38-
poetry install
40+
poetry env use 3.12 && poetry shell
41+
```
42+
43+
If using pip:
44+
45+
```bash
46+
python -m venv .venv && source .venv/bin/activate
3947
```
4048

41-
For IDE setup (optional):
49+
## Install dependencies
50+
51+
If using uv:
52+
4253
```bash
43-
poetry env info # Copy the interpreter path to use in your IDE (e.g. Cursor, VSCode)
54+
uv sync
55+
uv run dev
4456
```
4557

46-
Start the development server:
58+
If using poetry:
59+
4760
```bash
61+
poetry install
4862
poetry run dev
4963
```
5064

65+
If using pip:
66+
67+
```bash
68+
pip install -e .
69+
python -c "from src.services import watch_services; watch_services()"
70+
```
71+
5172
## Running Workflows
5273

5374
### Via UI
@@ -66,10 +87,24 @@ Execute workflows through the Restack API endpoint:
6687

6788
Run workflows programmatically using the Python client:
6889

90+
If using uv:
91+
92+
```bash
93+
uv run schedule
94+
```
95+
96+
If using poetry:
97+
6998
```bash
7099
poetry run schedule
71100
```
72101

102+
If using pip:
103+
104+
```bash
105+
python -c "from schedule_workflow import run_schedule_workflow; run_schedule_workflow()"
106+
```
107+
73108
This executes `schedule_workflow.py` which connects to Restack and runs the `CodeExecutionWorkflow`.
74109

75110
## Cloud Deployment

community/elevenlabs/README.md

Lines changed: 65 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -10,23 +10,23 @@ This repository contains a simple example project to help you get started with t
1010

1111
## Installation & Setup
1212

13-
### 1. Run Restack Local Engine with Docker
13+
## Run Restack Local Engine with Docker
1414

1515
Start the Restack service using Docker:
1616

1717
```bash
1818
docker run -d --pull always --name restack -p 5233:5233 -p 6233:6233 -p 7233:7233 ghcr.io/restackio/restack:main
1919
```
2020

21-
### 2. Open the Web UI
21+
## Open the Web UI
2222

2323
After running the Restack service, open the web UI to see the workflows and monitor the execution:
2424

2525
```bash
2626
http://localhost:5233
2727
```
2828

29-
### 3. Clone This Repository
29+
## Clone This Repository
3030

3131
Clone the repository and navigate to the example folder:
3232

@@ -35,26 +35,50 @@ git clone https://github.com/restackio/examples-python
3535
cd examples-python/examples/elevenlabs
3636
```
3737

38-
### 4. Install Dependencies Using Poetry
38+
## Start python shell
3939

40-
Set up the environment and install the necessary dependencies:
40+
If using uv:
4141

4242
```bash
43-
poetry env use 3.12
44-
poetry shell
45-
poetry install
46-
poetry env info # Optional: copy the interpreter path to use in your IDE (e.g. Cursor, VSCode, etc.)
43+
uv venv && source .venv/bin/activate
44+
```
45+
46+
If using poetry:
47+
48+
```bash
49+
poetry env use 3.12 && poetry shell
50+
```
51+
52+
If using pip:
53+
54+
```bash
55+
python -m venv .venv && source .venv/bin/activate
4756
```
4857

49-
### 5. Run the Services
58+
## Install dependencies
5059

51-
Start the Restack service with the defined workflows and functions:
60+
If using uv:
5261

5362
```bash
63+
uv sync
64+
uv run dev
65+
```
66+
67+
If using poetry:
68+
69+
```bash
70+
poetry install
5471
poetry run dev
5572
```
5673

57-
### 6. Export api key
74+
If using pip:
75+
76+
```bash
77+
pip install -e .
78+
python -c "from src.services import watch_services; watch_services()"
79+
```
80+
81+
## Export api key
5882

5983
```bash
6084
export ELEVEN_LABS_API_KEY= your_api_key_here
@@ -77,21 +101,49 @@ The following two functions are defined in this setup:
77101
To test the **Text to Speech** function
78102
First go to src/workflows/workflow.py and add your desired text in input_data and then use the following command:
79103

104+
If using uv:
105+
106+
```bash
107+
uv run text_to_speech
108+
```
109+
110+
If using poetry:
111+
80112
```bash
81113
poetry run text_to_speech
82114
```
83115

116+
If using pip:
117+
118+
```bash
119+
python -c "from src.schedule_workflow import run_schedule_workflow; run_schedule_workflow()"
120+
```
121+
84122
This will generate speech from the text and output the audio.
85123

86-
### 2. Test Voice Isolation
124+
## Test Voice Isolation
87125

88126
To test the **Voice Isolation** function,
89127
First go to **example-elevenlabs/schedule_workflow_audio_isolation.py** and add your audio file path in audio_path and then use the following command:
90128

129+
If using uv:
130+
131+
```bash
132+
uv run voice_isolation
133+
```
134+
135+
If using poetry:
136+
91137
```bash
92138
poetry run voice_isolation
93139
```
94140

141+
If using pip:
142+
143+
```bash
144+
python -c "from src.schedule_workflow_audio_isolation import run_schedule_workflow_audio_isolation; run_schedule_workflow_audio_isolation()"
145+
```
146+
95147
This will isolate the voice from the provided audio file and output the isolated voice audio.
96148

97149
## Project Structure

0 commit comments

Comments
 (0)