Reference

This section is the API reference, generated from the source code's docstrings. Each module has its own page, listing its classes, functions and constants with their full signatures.

Most applications import from a subpackage, for example from anagrapheus.timeline import ReplayPins. Each subpackage re-exports its public names, but each name is documented on the page of the module that defines it. So ReplayPins is documented under anagrapheus.timeline.replay, not under anagrapheus.timeline. The groups below say which module holds what.

The top-level package adds one function of its own, anagrapheus.register_builtin_events(registry). It registers every event type the library emits, across all subpackages, into an EventTypeRegistry. Call it once when you build your registry. Registering only some subpackages' events leads to an UnknownEventType error later, when a reader reaches an event type that was not registered.

Timeline

anagrapheus.timeline: The append-only event log, its SQLite store, the event-type registry, folds and projections, schema upcasting, the pin ledger, replay and recordings.

• envelope: DomainEvent, the base class for your own events, and the envelope and stored forms the log keeps.
• registry: EventTypeRegistry and EventKey, which name and version each event type.
• store: the store protocols, for a backend other than SQLite.
• sqlite: SQLiteEventStore.
• folds: ProjectionFold, GenerativeFold, OwnsPosition, PreparesSynchronously, Projector and FoldDeterminism.
• upcast: Upcast, UpcastRegistry and EventReader, which bring old event schemas forward as they are read.
• pins: PinLedger, pin_key, the PinResolver protocol, the pin events and is_bookkeeping, which matches them.
• replay: ReplayPins, PinMiss and Divergence.
• recording: write_recording, read_recording, pin_events, Recording and RecordingError.
• migrations: SchemaTooNew and the store's schema migrations.
• errors: TimelineError and its subclasses.

Provider

anagrapheus.provider: Model and tool calls sent through the pin ledger, and the call policy that decides when two calls are the same call.

• model: PinnedModel, which wraps any pydantic-ai model.
• tools: pinned_tool.
• policy: CallPolicy and the default SemanticCallPolicy.
• stream: PinnedStreamedResponse, the stream a replay rebuilds from a pinned response.
• errors: ProviderError.

Beliefs

anagrapheus.beliefs: Per-scope beliefs as a fold over the log, belief ids minted only from declared predicates, and the entity index (entity to belief ids) that re-keying reads.

• predicates: PredicateRegistry and Predicate, the only way to mint a belief id.
• ops: Revise, Expand, Contract, the Interpreter type that turns your events into them, and StateRef, which names a belief state an edge or a prompt part cites.
• events: BeliefRevised, BeliefExpanded and BeliefContracted.
• writer: BeliefEvents, which builds those events from a predicate and its entities.
• fold: BeliefFold.
• index: BeliefIndex.
• store and sqlite: the index store protocol and SQLiteBeliefIndexStore.
• rekey: plan_rekeys and BeliefRekey.
• divergence: divergence and Disagreement.
• migrations and errors: schema migrations, and BeliefError and its subclasses.

Identity

anagrapheus.identity: Entity identity as decisions recorded in the log, the registry folded from them, and the re-key rows a merge produces.

• decisions: establish, alias, merge, split, unmerge and mint_entity_id.
• events: the decision events.
• fold: IdentityFold.
• registry: IdentityRegistry, including rekeys_since.
• ladder: Ladder, your ordered list of stance tokens for how firmly an alias is held, used to rank candidates.
• vocabulary: IdentityVocabulary, which maps your own event types onto the identity decisions.
• store and sqlite: the identity store protocol and SQLiteIdentityStore.
• migrations and errors: schema migrations, and IdentityError and its subclasses.

Chronicle

anagrapheus.chronicle: Consolidation of log ranges into sections that cite the range they cover, read as recent events plus older history.

• fold: ChronicleFold, Summarizer, Consolidation, the unit boundaries UnitBoundary and EventTypes, and section_id.
• sections: Section and Anchor.
• reading: Brief, Recent, Anchors, Prose, Retriever and substring_retriever.
• store and sqlite: the chronicle store protocol, with export and load, and SQLiteChronicleStore.
• migrations: schema migrations.

Assembly

anagrapheus.assembly: Prompts built only from the slices of state a role was granted, with parts that cite their sources and a budget that never sheds a binding part.

• slices: EventsSlice, LogSlice, BeliefSlice, ChronicleSlice, Given and handed_out.
• parts: Part, Register, Source with its variants EventRef, SectionRef, GivenRef and the belief layer's StateRef, and Context.
• assemble: assemble and Budget.
• render: render_labelled.
• errors: AssemblyError and its subclasses, such as NotGranted and BudgetExceeded.