Skip to content

Commit 8539f62

Browse files
authored
Merge pull request #20 from vstorm-co/docs_update
docs: update docs and remove filesystem.py
2 parents 59ab4f9 + 26edefc commit 8539f62

27 files changed

Lines changed: 523 additions & 1847 deletions

CHANGELOG.md

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,27 @@ All notable changes to this project will be documented in this file.
55
The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
66
and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
77

8+
## [0.2.13] - 2025-01-17
9+
10+
### Changed
11+
12+
- **Breaking:** Updated `pydantic-ai-backend` dependency to `>=0.1.0`
13+
- **Breaking:** Removed `FilesystemBackend` and `LocalSandbox` - use `LocalBackend` instead
14+
- **Breaking:** Removed `FilesystemToolset` - use `create_console_toolset` from pydantic-ai-backend
15+
- Replaced custom filesystem toolset with `create_console_toolset` from pydantic-ai-backend
16+
- Re-exported `LocalBackend`, `create_console_toolset`, `get_console_system_prompt`, `ConsoleDeps` from pydantic-ai-backend
17+
18+
### Removed
19+
20+
- `pydantic_deep/toolsets/filesystem.py` - now provided by pydantic-ai-backend
21+
- `chardet` dependency - moved to pydantic-ai-backend
22+
23+
### Documentation
24+
25+
- Simplified backend documentation - now links to [pydantic-ai-backend docs](https://vstorm-co.github.io/pydantic-ai-backend/)
26+
- Updated all examples to use `LocalBackend` instead of `FilesystemBackend`
27+
- Updated toolsets documentation to reference Console Toolset from pydantic-ai-backend
28+
829
## [0.2.12] - 2025-01-16
930

1031
### Changed

CLAUDE.md

Lines changed: 10 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -30,16 +30,16 @@ This file provides guidance to Claude Code (claude.ai/code) when working with co
3030
- `DeepAgentDeps`: Dataclass holding agent dependencies (backend, working_dir, skills_dirs, subagents)
3131
- Passed to agent.run() for runtime configuration
3232

33-
**Backends (`pydantic_deep/backends/`)**
33+
**Backends (from [pydantic-ai-backend](https://github.com/vstorm-co/pydantic-ai-backend))**
3434
- `BackendProtocol`: Interface for file storage backends
3535
- `StateBackend`: In-memory file storage (for testing, ephemeral use)
36-
- `FilesystemBackend`: Real filesystem operations
36+
- `LocalBackend`: Real filesystem operations
3737
- `DockerSandbox`: Isolated Docker container execution
3838
- `CompositeBackend`: Combines multiple backends with routing
3939

4040
**Toolsets (`pydantic_deep/toolsets/`)**
41-
- `TodoToolset`: Task planning and tracking tools (read_todos, write_todos)
42-
- `FilesystemToolset`: File operations (read, write, edit, glob, grep, mkdir, execute)
41+
- `TodoToolset`: Task planning and tracking tools (read_todos, write_todos) - from [pydantic-ai-todo](https://github.com/vstorm-co/pydantic-ai-todo)
42+
- `create_console_toolset`: File operations (ls, read, write, edit, glob, grep, execute) - from [pydantic-ai-backend](https://github.com/vstorm-co/pydantic-ai-backend)
4343
- `SubAgentToolset`: Spawn and delegate to subagents
4444
- `SkillsToolset`: Load and use skill definitions from markdown files
4545

@@ -58,26 +58,27 @@ This file provides guidance to Claude Code (claude.ai/code) when working with co
5858

5959
**Backend Abstraction**
6060
```python
61-
from pydantic_deep import StateBackend, FilesystemBackend, CompositeBackend
61+
from pydantic_ai_backends import StateBackend, LocalBackend, CompositeBackend
6262

6363
# In-memory for testing
6464
backend = StateBackend()
6565

6666
# Real filesystem
67-
backend = FilesystemBackend(root="/path/to/workspace")
67+
backend = LocalBackend(root="/path/to/workspace")
6868

6969
# Combined backends
70-
backend = CompositeBackend(backends=[StateBackend(), FilesystemBackend()])
70+
backend = CompositeBackend(backends=[StateBackend(), LocalBackend()])
7171
```
7272

7373
**Toolset Registration**
7474
```python
7575
from pydantic_deep import create_deep_agent, DeepAgentDeps
76-
from pydantic_deep.toolsets import TodoToolset, FilesystemToolset
76+
from pydantic_ai_backends import create_console_toolset
77+
from pydantic_ai_todo import create_todo_toolset
7778

7879
agent = create_deep_agent(
7980
model="openai:gpt-4.1",
80-
toolsets=[TodoToolset(), FilesystemToolset()],
81+
toolsets=[create_todo_toolset(), create_console_toolset()],
8182
)
8283
```
8384

README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -24,8 +24,8 @@ See the [full demo application](https://github.com/vstorm-co/pydantic-deepagents
2424

2525
## Features
2626

27-
- **Multiple Backends**: StateBackend (in-memory), FilesystemBackend, DockerSandbox, CompositeBackend - via [pydantic-ai-backend](https://github.com/vstorm-co/pydantic-ai-backend)
28-
- **Rich Toolsets**: TodoToolset (via [pydantic-ai-todo](https://github.com/vstorm-co/pydantic-ai-todo)), FilesystemToolset, SubAgentToolset, SkillsToolset
27+
- **Multiple Backends**: StateBackend (in-memory), LocalBackend, DockerSandbox, CompositeBackend - via [pydantic-ai-backend](https://github.com/vstorm-co/pydantic-ai-backend)
28+
- **Rich Toolsets**: TodoToolset (via [pydantic-ai-todo](https://github.com/vstorm-co/pydantic-ai-todo)), Console Toolset (via [pydantic-ai-backend](https://github.com/vstorm-co/pydantic-ai-backend)), SubAgentToolset, SkillsToolset
2929
- **File Uploads**: Upload files for agent processing with `run_with_files()` or `deps.upload_file()`
3030
- **Skills System**: Extensible skill definitions with markdown prompts
3131
- **Structured Output**: Type-safe responses with Pydantic models via `output_type`

docs/api/agent.md

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -43,7 +43,7 @@ def create_deep_agent(
4343
| `skill_directories` | `list[SkillDirectory] \| None` | `None` | Directories to discover skills |
4444
| `backend` | `BackendProtocol \| None` | `StateBackend()` | File storage backend |
4545
| `include_todo` | `bool` | `True` | Include TodoToolset |
46-
| `include_filesystem` | `bool` | `True` | Include FilesystemToolset |
46+
| `include_filesystem` | `bool` | `True` | Include Console Toolset |
4747
| `include_subagents` | `bool` | `True` | Include SubAgentToolset |
4848
| `include_skills` | `bool` | `True` | Include SkillsToolset |
4949
| `include_general_purpose_subagent` | `bool` | `True` | Include general-purpose subagent |
@@ -109,13 +109,14 @@ def create_default_deps(
109109
### Example
110110
111111
```python
112-
from pydantic_deep import create_default_deps, FilesystemBackend
112+
from pydantic_deep import create_default_deps
113+
from pydantic_ai_backends import LocalBackend
113114
114115
# With default StateBackend
115116
deps = create_default_deps()
116117
117118
# With custom backend
118-
deps = create_default_deps(backend=FilesystemBackend("/workspace"))
119+
deps = create_default_deps(backend=LocalBackend("/workspace"))
119120
```
120121
121122
---

0 commit comments

Comments
 (0)