|
1 | | -Read the AGENTS.md file for instructions. |
2 | | -## AgentHub |
3 | | -- Central hub: `~/AgentHub/` |
4 | | -- Skills: `.agents/skills/` (symlinked to AgentHub shared skills) |
5 | | -- MCP: 12 servers synced across all agents |
6 | | -- Agents: 14 shared agents available |
7 | | -- Hooks: Safety, notification, and logging hooks |
| 1 | +# CLAUDE.md |
| 2 | + |
| 3 | +## Project: openai-agents-python |
| 4 | + |
| 5 | +**Organization:** AiFeatures (iAiFy Enterprise) |
| 6 | +**Language:** Python |
| 7 | +**Description:** Lightweight framework for building multi-agent workflows, provider-agnostic with support for 100+ LLMs |
| 8 | + |
| 9 | +## Build & Test |
| 10 | + |
| 11 | +```bash |
| 12 | +# Install dependencies |
| 13 | +uv sync --all-extras --all-packages --group dev |
| 14 | + |
| 15 | +# Run all tests |
| 16 | +make tests |
| 17 | + |
| 18 | +# Run tests in parallel (default) |
| 19 | +uv run pytest -n auto --dist loadfile -m "not serial" |
| 20 | + |
| 21 | +# Run serial tests only |
| 22 | +uv run pytest -m serial |
| 23 | + |
| 24 | +# Lint |
| 25 | +make lint |
| 26 | +# or: uv run ruff check |
| 27 | + |
| 28 | +# Format |
| 29 | +make format |
| 30 | +# or: uv run ruff format |
| 31 | + |
| 32 | +# Type checking |
| 33 | +make typecheck |
| 34 | +# runs mypy + pyright in parallel |
| 35 | + |
| 36 | +# Coverage |
| 37 | +make coverage |
| 38 | + |
| 39 | +# Full pre-PR check (format + lint + typecheck + tests) |
| 40 | +make check |
| 41 | + |
| 42 | +# Build docs |
| 43 | +make build-docs |
| 44 | + |
| 45 | +# Serve docs locally |
| 46 | +make serve-docs |
| 47 | +``` |
| 48 | + |
| 49 | +## Architecture |
| 50 | + |
| 51 | +```text |
| 52 | +src/agents/ # Core SDK package |
| 53 | + agent.py # Agent class with instructions, tools, guardrails, handoffs |
| 54 | + runner.py # Runner for executing agent workflows |
| 55 | + tools/ # Tool implementations (functions, MCP, hosted) |
| 56 | + guardrails/ # Input/output validation |
| 57 | + tracing/ # Built-in run tracking and debugging |
| 58 | + sessions/ # Conversation history management |
| 59 | + realtime/ # Voice agent support |
| 60 | +tests/ # Test suite |
| 61 | +examples/ # Usage examples and demos |
| 62 | +docs/ # MkDocs documentation source |
| 63 | +``` |
| 64 | + |
| 65 | +## Conventions |
| 66 | + |
| 67 | +- Conventional commits: `feat:`, `fix:`, `chore:`, `docs:` |
| 68 | +- Kebab-case file names |
| 69 | +- Branch protection on main -- PRs required |
| 70 | +- Python >= 3.10 required |
| 71 | +- Ruff for linting and formatting (line-length 100) |
| 72 | +- mypy + pyright for type checking |
| 73 | +- pytest with asyncio auto mode |
| 74 | + |
| 75 | +## Shared Resources |
| 76 | + |
| 77 | +| Asset | Location | |
| 78 | +| --- | --- | |
| 79 | +| CI/CD workflows | Ai-road-4-You/enterprise-ci-cd@v1 | |
| 80 | +| Composite actions | Ai-road-4-You/github-actions@v1 | |
| 81 | +| Governance | Ai-road-4-You/governance | |
| 82 | + |
| 83 | +## Fork Info |
| 84 | + |
| 85 | +- Upstream: openai/openai-agents-python |
| 86 | +- Do NOT create PRs to upstream |
| 87 | +- Sync managed by Ai-road-4-You/fork-sync |
| 88 | +- iAiFy-originated changes are MIT unless upstream license requires otherwise |
0 commit comments