Orchestrata code reference

This is the generated code reference for Orchestrata. A generator reads the source and writes one page per Python module and one index page per package. Each module page has a prose section, an at-a-glance table (source link, size, internal imports, importers and the tests that import it), class and dependency diagrams, the API tables, and the code listing. Each package page lists its subpackages and modules with their sizes. The hand-written prose sections are kept when the pages are regenerated; everything outside them is rewritten.

The reference is organised into groups, shown in the package table below.

• The main source package, orchestrata_ultimate, with its subpackages from core up to the services.
• orchestrata_tools, the analysis and test-generation toolkit, and orchestrata_ast, the AST library.
• scripts, the command-line and gate scripts.
• The components, one index per component built from the packages/*/src trees (contracts, gateway, governance, kernel, knowledge graph, session, tools and volks). Per-module pages for components are emitted only when the generator is run with the component-modules option, so the component entries are package-level listings.

Use it together with the curated pages. The architecture overview, the component DAG and the per-package narratives under modules (for example core and di) explain why the system is shaped as it is and how a request moves through it. The reference answers the exact questions: what a module defines, who imports it, which tests cover it, and what its signatures are. Package pages link to the curated narrative when one exists. A good route is to read the narrative first, then follow its module names into the reference.

To regenerate the pages, run the script scripts/gen-reference.py from the knowledge-wiki repository with the project option set to orchestrata; the command is given in the "How to regenerate" section below. Add the check option to see whether anything would change, and the component-modules option to also emit per-module pages for the components. The revision section records the source commit, and the permalinks in the pages use a second commit, as shown there.

Generated pages: one per Python module, with a class diagram, dependency diagram, API table, and the code listing. Package pages summarise each directory. Prose slots on every page are preserved on regeneration.

Revision

Packages

Components (packages/*/src)

How to regenerate

cd /home/mohamed/workspace/knowledge-wiki && /home/mohamed/workspace/knowledge-wiki/.venv/bin/python scripts/gen-reference.py --project orchestrata

Add --check to verify nothing would change (exit 1 if it would), and --component-modules to also emit per-module pages for the component packages.