markitect-tool/src/markitect_tool/__init__.py

"""Structured markdown primitives for markitect-tool."""

from markitect_tool.core import (
    ContentBlock,
    Document,
    Heading,
    MarkdownParseError,
    Section,
    parse_markdown,
    parse_markdown_file,
)
from markitect_tool.contract import (
    ContractCheckResult,
    ContractValidationResult,
    DocumentContract,
    check_document_contract,
    check_markdown_file,
    collect_metrics,
    load_contract_file,
    validate_contract,
    validate_contract_file,
)
from markitect_tool.cache import (
    CacheEntry,
    CacheManifest,
    CacheStatus,
    build_cache,
    cache_path_for,
    detect_changes,
    fingerprint_file,
    load_cache,
    save_cache,
    scan_markdown_files,
)
from markitect_tool.backend import (
    BACKEND_CAPABILITIES,
    DEFAULT_BACKEND_PATHS,
    AccessPolicyGateway,
    BackendCapabilityCheck,
    BackendManifest,
    BackendRegistry,
    BackendRegistryError,
    ContextPackageRegistry,
    DependencyEdge,
    DocumentSnapshot,
    EMPTY_PARSE_OPTIONS_HASH,
    IndexBackend,
    ProcessorResultStore,
    ProvenanceEnvelope,
    QueryAdapter,
    SnapshotPlanEntry,
    SnapshotRefreshPlan,
    SnapshotBackend,
    SnapshotIdentity,
    SnapshotState,
    capability_check,
    load_backend_manifest,
    load_backend_registry,
    load_snapshot_state_file,
    plan_snapshot_refresh,
    snapshot_identity_for_file,
)
from markitect_tool.content_class import (
    ClassCompositionResult,
    ContentClass,
    ContentClassRegistry,
    ContentClassResolutionError,
    load_content_class_file,
    load_content_classes,
)
from markitect_tool.diagnostics import Diagnostic, SourceLocation
from markitect_tool.explode import (
    EXPLODE_MANIFEST_NAME,
    ExplodeEntry,
    ExplodeError,
    ExplodeManifest,
    ExplodeResult,
    ImplodeResult,
    explode_markdown_file,
    implode_markdown_directory,
    load_explode_manifest,
)
from markitect_tool.generation import (
    GeneratedDocument,
    GenerationHookRequest,
    GenerationHookResult,
    GenerationPlan,
    GenerationResult,
    generate_stub_from_contract,
    generate_with_hook,
    load_generation_plan_file,
    run_generation_plan,
)
from markitect_tool.literate import (
    CodeChunk,
    LiterateFile,
    TangleResult,
    WeaveResult,
    discover_code_chunks,
    tangle_markdown,
    weave_markdown,
    write_tangle_files,
)
from markitect_tool.ops import (
    ComposeResult,
    IncludeError,
    IncludeResult,
    OperationProvenance,
    TransformResult,
    compose_files,
    resolve_includes,
    transform_markdown,
)
from markitect_tool.processor import (
    FencedProcessorBlock,
    ProcessorContext,
    ProcessorOutputFile,
    ProcessorRegistry,
    ProcessorRequest,
    ProcessorResult,
    ProcessorRun,
    default_processor_registry,
    discover_fenced_processors,
    run_fenced_processors,
)
from markitect_tool.query import (
    InvalidQueryError,
    QueryMatch,
    extract_document,
    query_document,
)
from markitect_tool.reference import (
    ContentUnit,
    ReferenceAddress,
    ReferenceContext,
    ReferenceResolution,
    ReferenceResolutionError,
    SourceSpan as ReferenceSourceSpan,
    load_namespaces,
    parse_reference,
    resolve_reference,
)
from markitect_tool.schema import (
    MarkdownSchema,
    SchemaValidationResult,
    ValidationViolation,
    load_schema_file,
    validate_document,
    validate_markdown_file,
)
from markitect_tool.template import (
    MissingTemplateVariable,
    TemplateAnalysis,
    TemplateError,
    TemplateRenderResult,
    analyze_template,
    render_template,
)

__all__ = [
    "ContentBlock",
    "Document",
    "Heading",
    "MarkdownParseError",
    "Section",
    "parse_markdown",
    "parse_markdown_file",
    "MarkdownSchema",
    "SchemaValidationResult",
    "ValidationViolation",
    "load_schema_file",
    "validate_document",
    "validate_markdown_file",
    "ContractCheckResult",
    "ContractValidationResult",
    "DocumentContract",
    "check_document_contract",
    "check_markdown_file",
    "collect_metrics",
    "load_contract_file",
    "validate_contract",
    "validate_contract_file",
    "CacheEntry",
    "CacheManifest",
    "CacheStatus",
    "build_cache",
    "cache_path_for",
    "detect_changes",
    "fingerprint_file",
    "load_cache",
    "save_cache",
    "scan_markdown_files",
    "BACKEND_CAPABILITIES",
    "DEFAULT_BACKEND_PATHS",
    "AccessPolicyGateway",
    "BackendCapabilityCheck",
    "BackendManifest",
    "BackendRegistry",
    "BackendRegistryError",
    "ContextPackageRegistry",
    "DependencyEdge",
    "DocumentSnapshot",
    "EMPTY_PARSE_OPTIONS_HASH",
    "IndexBackend",
    "ProcessorResultStore",
    "ProvenanceEnvelope",
    "QueryAdapter",
    "SnapshotPlanEntry",
    "SnapshotRefreshPlan",
    "SnapshotBackend",
    "SnapshotIdentity",
    "SnapshotState",
    "capability_check",
    "load_backend_manifest",
    "load_backend_registry",
    "load_snapshot_state_file",
    "plan_snapshot_refresh",
    "snapshot_identity_for_file",
    "ClassCompositionResult",
    "ContentClass",
    "ContentClassRegistry",
    "ContentClassResolutionError",
    "load_content_class_file",
    "load_content_classes",
    "Diagnostic",
    "SourceLocation",
    "EXPLODE_MANIFEST_NAME",
    "ExplodeEntry",
    "ExplodeError",
    "ExplodeManifest",
    "ExplodeResult",
    "ImplodeResult",
    "explode_markdown_file",
    "implode_markdown_directory",
    "load_explode_manifest",
    "GeneratedDocument",
    "GenerationHookRequest",
    "GenerationHookResult",
    "GenerationPlan",
    "GenerationResult",
    "generate_stub_from_contract",
    "generate_with_hook",
    "load_generation_plan_file",
    "run_generation_plan",
    "CodeChunk",
    "LiterateFile",
    "TangleResult",
    "WeaveResult",
    "discover_code_chunks",
    "tangle_markdown",
    "weave_markdown",
    "write_tangle_files",
    "ComposeResult",
    "IncludeError",
    "IncludeResult",
    "OperationProvenance",
    "TransformResult",
    "compose_files",
    "resolve_includes",
    "transform_markdown",
    "FencedProcessorBlock",
    "ProcessorContext",
    "ProcessorOutputFile",
    "ProcessorRegistry",
    "ProcessorRequest",
    "ProcessorResult",
    "ProcessorRun",
    "default_processor_registry",
    "discover_fenced_processors",
    "run_fenced_processors",
    "InvalidQueryError",
    "QueryMatch",
    "extract_document",
    "query_document",
    "ContentUnit",
    "ReferenceAddress",
    "ReferenceContext",
    "ReferenceResolution",
    "ReferenceResolutionError",
    "ReferenceSourceSpan",
    "load_namespaces",
    "parse_reference",
    "resolve_reference",
    "MissingTemplateVariable",
    "TemplateAnalysis",
    "TemplateError",
    "TemplateRenderResult",
    "analyze_template",
    "render_template",
]