Skip to main content

Typed persistence utilities for LangGraph-based OOAI applications.

Project description

ooai-persistence

CI Release Python PDM Coverage Async Postgres

ooai-persistence provides typed persistence helpers for LangGraph-based OOAI applications.

Responsibilities

  • checkpointer configuration and backend resolution
  • store configuration and backend resolution
  • graph cache configuration
  • strict serializer allowlist support
  • sync and async persistence contexts
  • local infrastructure defaults for Postgres, optional Redis, and optional MongoDB

Quick start

pdm install -G :all
pdm run pytest
pdm run ooai-persistence smoke --backend memory

For a no-infrastructure memory bundle:

from ooai_persistence import AppSettings, open_sync_persistence

settings = AppSettings.memory()

with open_sync_persistence(settings) as persistence:
    persistence.store.put(("users", "will"), "profile", {"name": "Will"})
    profile = persistence.store.get(("users", "will"), "profile")

For async usage:

from ooai_persistence import AppSettings, open_persistence

settings = AppSettings.local_sqlite(".ooai/persistence/dev.sqlite3")

async with open_persistence(settings) as persistence:
    ...

CLI

The package ships a small diagnostics and smoke-test CLI:

ooai-persistence doctor --backend postgres --json
ooai-persistence smoke --backend memory
ooai-persistence smoke --backend sqlite --sqlite-path .ooai/persistence/smoke.sqlite3
ooai-persistence smoke --backend postgres --async
ooai-persistence env --output .env
ooai-persistence ensure-postgres

The async Postgres smoke command exercises both the LangGraph checkpointer and store through the public context API.

Local Postgres

make bootstrap
make infra-up
make infra-test-postgres
make infra-down

make bootstrap creates .env from .env.example when needed and installs all PDM extras. See infra/README.md for Compose details.

make infra-test-postgres runs the real async Postgres E2E path and the CLI smoke path against Docker Compose Postgres.

If Docker is not installed but .env points at a reachable Postgres server, make infra-up falls back to ooai-persistence ensure-postgres and creates the configured database if needed.

Default backend behavior

By default, checkpointer and store use backend="auto".

auto resolves in this order:

  1. async Postgres when configured
  2. async SQLite when configured
  3. async MongoDB when configured
  4. async Redis when configured
  5. in-memory fallback

Serializer allowlist registry

The package includes a reusable strict-msgpack registry:

from ooai_persistence.serde.registry import MsgpackAllowlistRegistry

registry = MsgpackAllowlistRegistry()
registry.register_symbol("my_app.models", "WorkflowState")
registry.register_type(MyPersistedModel)
registry.register_import_string("my_app.models:AnotherPersistedModel")

That registry can be passed into the persistence context:

from ooai_persistence import AppSettings, open_persistence

settings = AppSettings()

async with open_persistence(settings, registry=registry) as bundle:
    ...

Documentation and release checks

pdm run sphinx-build -W -b html docs docs/_build/html
pdm build

CI runs formatting, linting, typing, tests with coverage, and the Sphinx build.

Releasing

Releases are tag-driven:

pdm lock --check
make check
git tag v0.2.0
git push origin v0.2.0

The release workflow verifies that the tag matches pyproject.toml, runs the async Postgres E2E checks, builds the wheel/sdist, publishes through PyPI Trusted Publishing, and creates a GitHub Release with artifacts attached.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

ooai_persistence-0.2.0.tar.gz (20.0 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

ooai_persistence-0.2.0-py3-none-any.whl (19.2 kB view details)

Uploaded Python 3

File details

Details for the file ooai_persistence-0.2.0.tar.gz.

File metadata

  • Download URL: ooai_persistence-0.2.0.tar.gz
  • Upload date:
  • Size: 20.0 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.12

File hashes

Hashes for ooai_persistence-0.2.0.tar.gz
Algorithm Hash digest
SHA256 895e89726210191b7f924d8642b0112a094755f238c114e145816c5933242a99
MD5 01ea7c42c6200a42ce22e56f924b4f14
BLAKE2b-256 29d7f398bea6cfe790cb79b66b0020b5445ba904f8cac672f0016b94040e8eb1

See more details on using hashes here.

Provenance

The following attestation bundles were made for ooai_persistence-0.2.0.tar.gz:

Publisher: release.yml on pr1m8/ooai-persistence

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file ooai_persistence-0.2.0-py3-none-any.whl.

File metadata

File hashes

Hashes for ooai_persistence-0.2.0-py3-none-any.whl
Algorithm Hash digest
SHA256 c0dab0c361e96eb6eebd1cd2347c968e1c283578b2b1c96e0a2fde7349c6bd94
MD5 6a6b335935d36f00f39c30c3c2b5f24c
BLAKE2b-256 b6b160803ba8f105292bd237b215b93473c42dec8d26da061b39b8cc02b3f805

See more details on using hashes here.

Provenance

The following attestation bundles were made for ooai_persistence-0.2.0-py3-none-any.whl:

Publisher: release.yml on pr1m8/ooai-persistence

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page