Skip to main content

edgar-transport-contracts

Producer-owned wire contracts for the edgar_updater → ai-excel-addin boundary (design edgar-to-build-model-e2e-type-and-transport-contract-design-2026-10-22.md, ratified §4 Q1–Q8; S-XREPO-1). This package is the one owner of every closed wire vocabulary and structural invariant on that boundary: both repos pin it by version and neither re-declares a member of a contract set.

Shapes and validators only — no behaviour, no I/O, no imports from edgar_api, edgar_parser or packages/edgar_shared. Its sole dependency is pydantic>=2.10,<3.

Contents:

  • enums — NonGaapOutputMetricId, NonGaapAdjustmentRole, BridgeGranularity, OmittedTableStage / OmittedTableReason (ratified 5) with LEGACY_OMITTED_TABLE_REASONS for the tolerant reader, KpiGapReason (6 + financials_unavailable), NonGaapMetricFamily, BridgeFailureReason.
  • measure — MeasureUnit, Scale, ScaleProvenance, MeasureType, ScaledQuantity, EvidencedBlank.
  • period — one TypedPeriod (annual|quarterly|ytd|ttm + temporal_kind) with canonical_label().
  • dimensions — DimensionAxis, XbrlFactRef, and the one serialize_dimensions / parse_dimensions (|-joined, escaped) form.
  • kpi — KpiDriverRowsV2, TypedKpiObservation, OmittedTable, KpiLaneGap, ReaderRecord.
  • tables — FilingTableEnvelope and TableBinding / ColumnBinding / RowBinding / CellRef, published as extra="forbid" models.
  • non_gaap_bridge — IssuerNonGaapBridgeV3 (canonical_output_metric + output_metric_slug, effective_metric_key, producer-minted bridge_id, granularity, typed closure: BridgeClosureState, flattened subtotals — no chained_from) and IssuerNonGaapBridgeResponseV3. Its rounding_consistent diagnostic preserves the printed-equation residual within the half-ulp budget; like other ordinary diagnostics, it does not carry metric-context fields (effective_metric_key, period, or label).
  • canonicalize — OUTPUT_METRIC_SURFACE_FORMS and classify_adjustment_role, beside the enums they feed.
  • version — CONTRACT_VERSIONS and version_refusal(received, expected).
  • golden — the 13-issuer golden pack skeleton and its golden.load(issuer, kind) loader (contents land in S-XREPO-5).

Install for development from the producer repo root: pip install -e packages/edgar_transport_contracts. Run its tests with .venv/bin/python -m pytest packages/edgar_transport_contracts/tests -q.

Metadata

Release files for edgar-transport-contracts 0.1.1

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for edgar-transport-contracts 0.1.1
File Size Uploaded Provenance
edgar_transport_contracts-0.1.1.tar.gz 230.5 kB Without provenance Details

Built distribution (wheel)

Table of built distributions (wheels) for edgar-transport-contracts 0.1.1
File Interpreter ABI Platform
edgar_transport_contracts-0.1.1-py3-none-any.whl Python 3 none any Details

Total release size: 480.1 kB

Release files / edgar_transport_contracts-0.1.1.tar.gz

Download URL edgar_transport_contracts-0.1.1.tar.gz
Size 230.5 kB
Tags Source
SHA-256 checksum
How to use checksums
3bebddf253e4a07e8e25322cfa5d29a48cbaab6771477fad0c57b9aa9268e0cd
BLAKE2b-256 checksum
How to use checksums
e6679b46690d85b0960aa3988653767c738766559af78e43eb2e25378e9852c3
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/7.0.0 CPython/3.13.15

Release files / edgar_transport_contracts-0.1.1-py3-none-any.whl

Download URL edgar_transport_contracts-0.1.1-py3-none-any.whl
Size 249.5 kB
Tags Python 3
SHA-256 checksum
How to use checksums
ea4ba9f0af7a22faa5bbfb1e7c50316635561b81822057fa30d4c77c2e198480
BLAKE2b-256 checksum
How to use checksums
d054fec949f24decec90f55d005677eb0e8ae71bea42dd579005be9fc68c6a28
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/7.0.0 CPython/3.13.15

Security for edgar-transport-contracts 0.1.1

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

No provenance found

None of the files in this release were uploaded with provenance metadata.

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.

To learn more about protecting yourself from malicious actors, visit our package security documentation.

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page