docs(src): Update documentation for src/ layout and sloppy.py entry point
This commit is contained in:
42
Readme.md
42
Readme.md
@@ -35,24 +35,26 @@ The **MMA (Multi-Model Agent)** system decomposes epics into tracks, tracks into
|
||||
|
||||
## Module Map
|
||||
|
||||
| File | Lines | Role |
|
||||
|---|---|---|
|
||||
| `gui_2.py` | ~3080 | Primary ImGui interface — App class, frame-sync, HITL dialogs |
|
||||
| `ai_client.py` | ~1800 | Multi-provider LLM abstraction (Gemini, Anthropic, DeepSeek, Gemini CLI) |
|
||||
| `mcp_client.py` | ~870 | 26 MCP tools with filesystem sandboxing and tool dispatch |
|
||||
| `api_hooks.py` | ~330 | HookServer — REST API for external automation on `:8999` |
|
||||
| `api_hook_client.py` | ~245 | Python client for the Hook API (used by tests and external tooling) |
|
||||
| `multi_agent_conductor.py` | ~250 | ConductorEngine — Tier 2 orchestration loop with DAG execution |
|
||||
| `conductor_tech_lead.py` | ~100 | Tier 2 ticket generation from track briefs |
|
||||
| `dag_engine.py` | ~100 | TrackDAG (dependency graph) + ExecutionEngine (tick-based state machine) |
|
||||
| `models.py` | ~100 | Ticket, Track, WorkerContext dataclasses |
|
||||
| `events.py` | ~89 | EventEmitter, AsyncEventQueue, UserRequestEvent |
|
||||
| `project_manager.py` | ~300 | TOML config persistence, discussion management, track state |
|
||||
| `session_logger.py` | ~200 | JSON-L + markdown audit trails (comms, tools, CLI, hooks) |
|
||||
| `shell_runner.py` | ~100 | PowerShell execution with timeout, env config, QA callback |
|
||||
| `file_cache.py` | ~150 | ASTParser (tree-sitter) — skeleton and curated views |
|
||||
| `summarize.py` | ~120 | Heuristic file summaries (imports, classes, functions) |
|
||||
| `outline_tool.py` | ~80 | Hierarchical code outline via stdlib `ast` |
|
||||
Core implementation resides in the `src/` directory.
|
||||
|
||||
| File | Role |
|
||||
|---|---|
|
||||
| `src/gui_2.py` | Primary ImGui interface — App class, frame-sync, HITL dialogs |
|
||||
| `src/ai_client.py` | Multi-provider LLM abstraction (Gemini, Anthropic, DeepSeek, Gemini CLI) |
|
||||
| `src/mcp_client.py` | 26 MCP tools with filesystem sandboxing and tool dispatch |
|
||||
| `src/api_hooks.py` | HookServer — REST API for external automation on `:8999` |
|
||||
| `src/api_hook_client.py` | Python client for the Hook API (used by tests and external tooling) |
|
||||
| `src/multi_agent_conductor.py` | ConductorEngine — Tier 2 orchestration loop with DAG execution |
|
||||
| `src/conductor_tech_lead.py` | Tier 2 ticket generation from track briefs |
|
||||
| `src/dag_engine.py` | TrackDAG (dependency graph) + ExecutionEngine (tick-based state machine) |
|
||||
| `src/models.py` | Ticket, Track, WorkerContext dataclasses |
|
||||
| `src/events.py` | EventEmitter, AsyncEventQueue, UserRequestEvent |
|
||||
| `src/project_manager.py` | TOML config persistence, discussion management, track state |
|
||||
| `src/session_logger.py` | JSON-L + markdown audit trails (comms, tools, CLI, hooks) |
|
||||
| `src/shell_runner.py` | PowerShell execution with timeout, env config, QA callback |
|
||||
| `src/file_cache.py` | ASTParser (tree-sitter) — skeleton and curated views |
|
||||
| `src/summarize.py` | Heuristic file summaries (imports, classes, functions) |
|
||||
| `src/outline_tool.py` | Hierarchical code outline via stdlib `ast` |
|
||||
|
||||
---
|
||||
|
||||
@@ -89,8 +91,8 @@ api_key = "YOUR_KEY"
|
||||
### Running
|
||||
|
||||
```powershell
|
||||
uv run gui_2.py # Normal mode
|
||||
uv run gui_2.py --enable-test-hooks # With Hook API on :8999
|
||||
uv run sloppy.py # Normal mode
|
||||
uv run sloppy.py --enable-test-hooks # With Hook API on :8999
|
||||
```
|
||||
|
||||
### Running Tests
|
||||
|
||||
Reference in New Issue
Block a user