adcp-reporting-storage

PostgreSQL and object-storage implementations of the AdCP Reliable Reporting stores, maintained in the adcp-client-python repository and versioned on its own line.

adcp defines the store protocols, the in-memory stores, the producer, the get_reporting_status handlers, the reconciliation logic and the row encoding. This distribution implements those protocols durably:

Every public name is also importable from the top-level package, lazily:

from psycopg_pool import AsyncConnectionPool

from adcp.reporting.ledger import ProducerOfferings, ReportingProducer
from adcp_reporting_storage import PgReportingLedgerStore, ReportingRowStorageOptionsV1

async with AsyncConnectionPool(dsn, min_size=2, max_size=10) as pool:
    store = PgReportingLedgerStore(
        pool=pool,
        row_storage=ReportingRowStorageOptionsV1(deployment_namespace="prod-us"),
    )
    await store.create_schema()
    producer = ReportingProducer(source=..., offerings=ProducerOfferings(...), store=store)
    await producer.run_worker()

Install

pip install "adcp-reporting-storage[pg]"            # PostgreSQL stores (psycopg)
pip install "adcp-reporting-storage[pg,gcs]"        # + rows on Google Cloud Storage
pip install "adcp-reporting-storage[pg,s3]"         # + rows on Amazon S3
pip install "adcp-reporting-storage[pg,azure]"      # + rows on Azure Blob Storage

adcp is a dependency and is installed with it. The cloud providers take a client you build; the extras only pin the client libraries.

Compatibility

This package implements the protocols of one adcp major and imports a few private helpers of adcp.reporting to do so (adcp.reporting.ledger._record_rows, _delivery_state, status_snapshot). Its dependency range is therefore one major (adcp>=9.0.0,<10), and a new adcp major means a new release here. adcp never imports this package; a test in the main repository enforces that.

Versioning

0.x: breaking changes may land in a minor release, each with a migration note in CHANGELOG.md. The package reaches 1.0 when the storage layout shared with the JavaScript SDK (@adcp/reporting-storage) is declared stable.

Documentation

The guides live in the repository: Reliable Reporting service, row storage, ledger migrations, caller-ownership migration, and the migration note for the 9.0 split.