How-To Guides

Goal-oriented recipes for common tasks. Each guide answers a specific “how do I…” question.

Install zodb-json-codec

Install from PyPI with pre-built wheels, or with uv. Verify the installation works.

Install zodb-json-codec

Integrate with zodb-pgjsonb

Use the codec as the transcoding layer for PostgreSQL JSONB storage. Understand the fast paths and the data pipeline.

Integrate with zodb-pgjsonb

Handle custom and unknown types

Learn how the codec handles types it does not recognize, and what the @reduce and @pkl markers mean.

Handle custom and unknown types

Run benchmarks

Run synthetic and real-world benchmarks. Build with PGO for production-accurate numbers.

Run benchmarks

Build from source

Set up a development environment with Rust, maturin, and Python. Run the Rust and Python test suites.

Build from source