Skip to content

Commit 0edf364

Browse files
committed
docs: Update README with API overview, badges, and installation instructions, and refine CHANGELOG entries for clarity and naming consistency.
1 parent cc50646 commit 0edf364

2 files changed

Lines changed: 20 additions & 4 deletions

File tree

CHANGELOG.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@ Built-in `system.*` modules that allow AI agents to query, monitor
2222
- **`system.control.update_config`** — Runtime config hot-patching with constraint validation.
2323
- **`system.control.reload_module`** — Hot-reload a module from disk without restart.
2424
- **`system.control.toggle_feature`** — Enable/disable modules at runtime with reason tracking.
25-
- **`registerSysModules()`** — Auto-registration wiring for all system modules.
25+
- **`register_sys_modules()`** — Auto-registration wiring for all system modules.
2626

2727
#### Observability
2828
- **`ErrorHistory`** — Ring buffer tracking recent errors with deduplication and per-module querying.
@@ -49,7 +49,7 @@ Built-in `system.*` modules that allow AI agents to query, monitor
4949
- **`ExportProfile`** — Enum for schema export profiles (`mcp`, `openai`, `anthropic`, `generic`).
5050

5151
#### Registry
52-
- **Module toggle**`Registry` now supports `disable()`/`enable()` with `ModuleDisabledError` enforcement and event emission.
52+
- **Module toggle**APCore client now supports `disable()`/`enable()` for module toggling via `system.control.toggle_feature`, with `ModuleDisabledError` enforcement and event emission.
5353
- **Version negotiation**`negotiate_version()` for SDK/module version compatibility checking.
5454

5555

README.md

Lines changed: 18 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,9 @@
44

55
# apcore
66

7+
![Python](https://img.shields.io/badge/python-3.11+-blue.svg)
8+
![License](https://img.shields.io/badge/license-Apache%202.0-green.svg)
9+
710
Schema-driven module development framework for AI-perceivable interfaces.
811

912
**apcore** provides a unified task orchestration framework with strict type safety, access control, middleware pipelines, and built-in observability. It enables you to define modules with structured input/output schemas that are easily consumed by LLMs and other automated systems.
@@ -24,6 +27,19 @@ Schema-driven module development framework for AI-perceivable interfaces.
2427
- **Async task management** -- Background module execution with status tracking, cancellation, and concurrency limiting
2528
- **W3C Trace Context** -- traceparent header injection/extraction for distributed tracing interop
2629

30+
## API Overview
31+
32+
| Class | Description |
33+
|-------|-------------|
34+
| `APCore` | High-level client -- register modules, call, stream, validate |
35+
| `Registry` | Module storage -- discover, register, get, list, watch |
36+
| `Executor` | Execution engine -- call with middleware pipeline, ACL, approval |
37+
| `Context` | Request context -- trace ID, identity, call chain, cancel token |
38+
| `Config` | Configuration -- load from YAML, get/set values |
39+
| `ACL` | Access control -- rule-based caller/target authorization |
40+
| `Middleware` | Pipeline hooks -- before/after/on_error interception |
41+
| `EventEmitter` | Event system -- subscribe, emit, flush |
42+
2743
## Documentation
2844

2945
For full documentation, including Quick Start guides for both Python and TypeScript, visit:
@@ -36,10 +52,10 @@ For full documentation, including Quick Start guides for both Python and TypeScr
3652
## Installation
3753

3854
```bash
39-
pip install -e .
55+
pip install apcore
4056
```
4157

42-
For development:
58+
### Development
4359

4460
```bash
4561
pip install -e ".[dev]"

0 commit comments

Comments
 (0)