Skip to content

Commit f58a064

Browse files
committed
refactor: Update directory structure documentation for clarity and organization
1 parent ca85111 commit f58a064

File tree

1 file changed

+54
-40
lines changed

1 file changed

+54
-40
lines changed

docs/architecture/directory-structure.md

Lines changed: 54 additions & 40 deletions
Original file line numberDiff line numberDiff line change
@@ -8,46 +8,60 @@ The core framework provides task orchestration and execution specifications. All
88

99
```
1010
core/
11-
├── interfaces/ # Core interfaces (abstract contracts)
12-
│ └── executable_task.py # ExecutableTask interface
13-
├── base/ # Base class implementations
14-
│ └── base_task.py # BaseTask base class with common functionality
15-
├── types.py # Core type definitions (TaskTreeNode, TaskStatus, hooks)
16-
├── decorators.py # Unified decorators (Flask-style API)
17-
│ # register_pre_hook, register_post_hook, extension_register
18-
├── config/ # Configuration registry
19-
│ └── registry.py # ConfigRegistry for hooks and TaskModel
20-
├── execution/ # Task orchestration specifications
21-
│ ├── task_manager.py # TaskManager - core orchestration engine
22-
│ ├── task_executor.py # TaskExecutor - task execution interface
23-
│ ├── task_creator.py # TaskCreator - task tree creation and validation
24-
│ ├── task_tracker.py # TaskTracker - task execution tracking
25-
│ ├── executor_registry.py # ExecutorRegistry - executor registration
26-
│ └── streaming_callbacks.py # Streaming support
27-
├── extensions/ # Extension system
28-
│ ├── base.py # Extension base class
29-
│ ├── decorators.py # @extension_register decorator
30-
│ ├── registry.py # ExtensionRegistry
31-
│ ├── protocol.py # Protocol-based design (ExecutorLike, ExecutorFactory)
32-
│ ├── types.py # ExtensionCategory enum
33-
│ ├── hook.py # Hook system implementation
34-
│ └── storage.py # Storage extension base
35-
├── storage/ # Storage implementation
36-
│ ├── factory.py # create_storage() function
37-
│ ├── sqlalchemy/ # SQLAlchemy implementation
38-
│ │ ├── models.py # SQLAlchemy models
39-
│ │ └── task_repository.py # Task repository implementation
40-
│ └── dialects/ # Database dialects (DuckDB/PostgreSQL)
41-
│ ├── duckdb.py
42-
│ ├── postgres.py
43-
│ └── registry.py
44-
├── tools/ # Tool system
45-
│ ├── base.py # Tool base class
46-
│ ├── decorators.py # @tool_register decorator
47-
│ └── registry.py # ToolRegistry
48-
└── utils/ # Utility functions
49-
├── logger.py # Logging utilities
50-
└── helpers.py # Helper functions
11+
├── __init__.py
12+
├── base/
13+
│ └── base_task.py
14+
├── builders.py
15+
├── config/
16+
│ └── registry.py
17+
├── config_manager.py
18+
├── decorators.py
19+
├── dependency/
20+
├── execution/
21+
│ ├── errors.py
22+
│ ├── executor_registry.py
23+
│ ├── streaming_callbacks.py
24+
│ ├── task_creator.py
25+
│ ├── task_executor.py
26+
│ ├── task_manager.py
27+
│ └── task_tracker.py
28+
├── extensions/
29+
│ ├── base.py
30+
│ ├── decorators.py
31+
│ ├── executor_metadata.py
32+
│ ├── hook.py
33+
│ ├── manager.py
34+
│ ├── protocol.py
35+
│ ├── registry.py
36+
│ ├── storage.py
37+
│ └── types.py
38+
├── interfaces/
39+
│ └── executable_task.py
40+
├── storage/
41+
│ ├── context.py
42+
│ ├── dialects/
43+
│ │ ├── duckdb.py
44+
│ │ ├── postgres.py
45+
│ │ └── registry.py
46+
│ ├── factory.py
47+
│ ├── migrate.py
48+
│ ├── migrations/
49+
│ └── sqlalchemy/
50+
│ ├── models.py
51+
│ └── task_repository.py
52+
├── tools/
53+
│ ├── base.py
54+
│ ├── decorators.py
55+
│ └── registry.py
56+
├── types.py
57+
├── utils/
58+
│ ├── helpers.py
59+
│ ├── llm_key_context.py
60+
│ ├── llm_key_injector.py
61+
│ ├── logger.py
62+
│ └── project_detection.py
63+
├── validator/
64+
└── __pycache__/
5165
```
5266

5367
## Extensions (`extensions/`)

0 commit comments

Comments
 (0)