Skip to content

Commit 2c56c6d

Browse files
committed
notebooks complete
1 parent b5a8a8b commit 2c56c6d

File tree

2 files changed

+47
-5
lines changed

2 files changed

+47
-5
lines changed

src/agentex/lib/cli/templates/default/README.md.j2

Lines changed: 23 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -62,6 +62,7 @@ This file is essential for both local development and deployment of your agent.
6262
│ └── acp.py # ACP server and event handlers
6363
├── Dockerfile # Container definition
6464
├── manifest.yaml # Deployment config
65+
├── dev.ipynb # Development notebook for testing
6566
{% if use_uv %}
6667
└── pyproject.toml # Dependencies (uv)
6768
{% else %}
@@ -76,7 +77,27 @@ This file is essential for both local development and deployment of your agent.
7677
- Add your own tools and capabilities
7778
- Implement custom state management
7879

79-
### 2. Manage Dependencies
80+
### 2. Test Your Agent with the Development Notebook
81+
Use the included `dev.ipynb` Jupyter notebook to test your agent interactively:
82+
83+
```bash
84+
# Start Jupyter notebook (make sure you have jupyter installed)
85+
jupyter notebook dev.ipynb
86+
87+
# Or use VS Code to open the notebook directly
88+
code dev.ipynb
89+
```
90+
91+
The notebook includes:
92+
- **Setup**: Connect to your local AgentEx backend
93+
- **Task creation**: Create a new task for the conversation
94+
- **Event sending**: Send events to the agent and get responses
95+
- **Async message subscription**: Subscribe to server-side events to receive agent responses
96+
- **Rich message display**: Beautiful formatting with timestamps and author information
97+
98+
The notebook automatically uses your agent name (`{{ agent_name }}`) and demonstrates the agentic ACP workflow: create task → send event → subscribe to responses.
99+
100+
### 3. Manage Dependencies
80101

81102
{% if use_uv %}
82103
You chose **uv** for package management. Here's how to work with dependencies:
@@ -115,7 +136,7 @@ pip install -r requirements.txt
115136
- Wide compatibility
116137
{% endif %}
117138

118-
### 3. Configure Credentials
139+
### 4. Configure Credentials
119140
Options:
120141
1. Add any required credentials to your manifest.yaml via the `env` section
121142
2. Export them in your shell: `export OPENAI_API_KEY=...`

src/agentex/lib/cli/templates/temporal/README.md.j2

Lines changed: 24 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -68,6 +68,7 @@ This file is essential for both local development and deployment of your agent.
6868
│ └── run_worker.py # Temporal worker setup
6969
├── Dockerfile # Container definition
7070
├── manifest.yaml # Deployment config
71+
├── dev.ipynb # Development notebook for testing
7172
{% if use_uv %}
7273
└── pyproject.toml # Dependencies (uv)
7374
{% else %}
@@ -82,12 +83,32 @@ This file is essential for both local development and deployment of your agent.
8283
- Add your own tools and capabilities
8384
- Implement custom state management
8485

85-
### 2. Develop Temporal Workflows
86+
### 2. Test Your Agent with the Development Notebook
87+
Use the included `dev.ipynb` Jupyter notebook to test your agent interactively:
88+
89+
```bash
90+
# Start Jupyter notebook (make sure you have jupyter installed)
91+
jupyter notebook dev.ipynb
92+
93+
# Or use VS Code to open the notebook directly
94+
code dev.ipynb
95+
```
96+
97+
The notebook includes:
98+
- **Setup**: Connect to your local AgentEx backend
99+
- **Task creation**: Create a new task for the conversation
100+
- **Event sending**: Send events to the agent and get responses
101+
- **Async message subscription**: Subscribe to server-side events to receive agent responses
102+
- **Rich message display**: Beautiful formatting with timestamps and author information
103+
104+
The notebook automatically uses your agent name (`{{ agent_name }}`) and demonstrates the agentic ACP workflow: create task → send event → subscribe to responses.
105+
106+
### 3. Develop Temporal Workflows
86107
- Edit `workflow.py` to define your agent's async workflow logic
87108
- Modify `activities.py` to add custom activities
88109
- Use `run_worker.py` to configure the Temporal worker
89110

90-
### 3. Manage Dependencies
111+
### 4. Manage Dependencies
91112

92113
{% if use_uv %}
93114
You chose **uv** for package management. Here's how to work with dependencies:
@@ -135,7 +156,7 @@ pip install -r requirements.txt
135156
- Wide compatibility
136157
{% endif %}
137158

138-
### 4. Configure Credentials
159+
### 5. Configure Credentials
139160
- Add any required credentials to your manifest.yaml
140161
- For local development, create a `.env` file in the project directory
141162
- Use `load_dotenv()` only in development mode:

0 commit comments

Comments
 (0)