Execution Model¶

bijux-canon-ingest executes work by receiving inputs at its interfaces, coordinating policy and workflows in application code, and delegating specific responsibilities to owned modules.

This page should give a reader one clean story about how work moves through the package. The goal is not to describe every branch, but to make the main path recognizable before someone opens the implementation.

Treat the architecture pages for bijux-canon-ingest as a reviewer-facing map of structure and flow. They should shorten code reading, not try to replace it.

Visual Summary¶

flowchart RL
    page["Execution Model<br/>clarifies: trace execution | spot dependency pressure | judge structural drift"]
    classDef page fill:#dbeafe,stroke:#1d4ed8,color:#1e3a8a,stroke-width:2px;
    classDef positive fill:#dcfce7,stroke:#16a34a,color:#14532d;
    classDef caution fill:#fee2e2,stroke:#dc2626,color:#7f1d1d;
    classDef anchor fill:#ede9fe,stroke:#7c3aed,color:#4c1d95;
    classDef action fill:#fef3c7,stroke:#d97706,color:#7c2d12;
    module1["package workflows"]
    module1 --> page
    module2["deterministic document transforms"]
    module2 --> page
    module3["retrieval-oriented models and assembly"]
    module3 --> page
    code1["src/bijux_canon_ingest/application"]
    page --> code1
    code2["src/bijux_canon_ingest/processing"]
    page --> code2
    code3["src/bijux_canon_ingest/retrieval"]
    page --> code3
    pressure1["tests/unit for module-level behavior across processing, retrieval, and interfaces"]
    pressure1 -.tests whether this structure still holds.-> page
    pressure2["tests/e2e for package boundary coverage"]
    pressure2 -.tests whether this structure still holds.-> page
    pressure3["tests/invariants for long-lived repository promises"]
    pressure3 -.tests whether this structure still holds.-> page
    class page page;
    class module1,module2,module3 positive;
    class code1,code2,code3 anchor;
    class pressure1,pressure2,pressure3 caution;

Execution Anchors¶

entry surfaces: CLI entrypoint in src/bijux_canon_ingest/interfaces/cli/entrypoint.py, HTTP boundaries under src/bijux_canon_ingest/interfaces, configuration modules under src/bijux_canon_ingest/config
workflow modules: src/bijux_canon_ingest/processing, src/bijux_canon_ingest/retrieval, src/bijux_canon_ingest/application
outputs: normalized document trees, chunk collections and retrieval-ready records, diagnostic output produced during ingest workflows

Concrete Anchors¶

src/bijux_canon_ingest/processing for deterministic document transforms
src/bijux_canon_ingest/retrieval for retrieval-oriented models and assembly
src/bijux_canon_ingest/application for package workflows

Use This Page When¶

you are tracing structure, execution flow, or dependency pressure
you need to understand how modules fit before refactoring
you are reviewing design drift rather than one isolated bug

Decision Rule¶

Use Execution Model to decide whether a structural change makes bijux-canon-ingest easier or harder to explain in terms of modules, dependency direction, and execution flow. If the change works only because the design becomes harder to read, the safer answer is redesign rather than acceptance.

What This Page Answers¶

how bijux-canon-ingest is organized internally in terms a reviewer can follow
which modules carry the main execution and dependency story
where structural drift would show up before it becomes expensive

Reviewer Lens¶

trace the described execution path through the named modules instead of trusting the diagram alone
look for dependency direction or layering that now contradicts the documented seam
verify that the structural risks named here still match the current code shape

Honesty Boundary¶

This page describes the current structural model of bijux-canon-ingest, but it does not guarantee that every import path or runtime path still obeys that model. Readers should treat it as a map that must stay aligned with code and tests, not as an authority above them.

Next Checks¶

move to interfaces when the review reaches a public or operator-facing seam
move to operations when the concern becomes repeatable runtime behavior
move to quality when you need proof that the documented structure is still protected

Purpose¶

This page summarizes the package execution model before readers inspect individual modules.

Stability¶

Keep it aligned with the actual workflow code and entrypoints.