Skip to main content

panproto

PyPI Python License: MIT

Python bindings for panproto, a schematic version-control system that treats every supported schema language (around 50, including ATProto, OpenAPI, AsyncAPI, Avro, Protobuf, JSON Schema, and Kubernetes CRDs) as views over a single graph format.

The bindings are built with PyO3 against the Rust core directly: no WASM runtime, no subprocess, no shelling out. The full panproto surface is available from Python, including the schema/migration/lens/VCS pipelines and the tree-sitter-driven parser for 259 programming languages.

Status

panproto is pre-1.0. The 0.x series carries arbitrary breaking changes between minor versions; the panproto package version tracks the workspace version on every release. Python 3.13+ is required (the wheels are abi3 and forward-compatible across newer Python releases).

Installation

pip install panproto

Wheels are published on PyPI for Linux x86_64/aarch64, macOS arm64+x86_64, and Windows x86_64. No Rust toolchain is required to install.

Synopsis

import panproto

# Pick a built-in protocol, or define your own with `Protocol.from_theories`.
atproto = panproto.get_builtin_protocol("atproto")

# Build a schema using the fluent builder.
v1 = atproto.schema()
v1.vertex("post", "record", "app.bsky.feed.post")
v1.vertex("post:body", "object")
v1.vertex("post:body.text", "string")
v1.edge("post", "post:body", "record-schema")
v1.edge("post:body", "post:body.text", "prop", "text")
v1.constraint("post:body.text", "maxLength", "3000")
schema_v1 = v1.build()

# (build schema_v2 the same way, with the field renamed to `content` ...)

# Detect breaking changes.
report = panproto.diff_and_classify(schema_v1, schema_v2, atproto)
print(report.compatible)        # True or False
print(report.report_text())     # human-readable summary

# Auto-generate a bidirectional converter.
lens, quality, _ = panproto.auto_generate_lens(schema_v1, schema_v2, atproto)
view, complement = lens.get(instance)
restored = lens.put(view, complement)

# Version-control schemas.
repo = panproto.Repository.init("/path/to/repo")
repo.add(schema_v1)
repo.commit("initial schema", "anonymous")
repo.create_and_checkout_branch("feature")
repo.merge("feature", "anonymous")

API overview

Module / class Purpose
Schema, SchemaBuilder Fluent schema construction; Schema.validate(protocol) checks rules.
Protocol Schema-language definition. Protocol.from_theories(...) builds one from a Theory.
get_builtin_protocol(name) Load any of the ~50 builtin protocols by name.
define_protocol(spec) Define a custom protocol from a dict.
Theory, create_theory, TheoryBuilder GAT-level theory construction. Theory.from_nickel(src) / from_yaml(src) / from_json(src) / from_path(p) load theory-DSL documents; to_yaml() / from_dict_yaml(s) round-trip the flat panproto_gat::Theory shape (JSON pair already provided).
diff_schemas, diff_and_classify Structural diff and breaking-change classification.
auto_generate_lens Generate a bidirectional Lens from two schemas.
Lens get(instance) -> (view, complement), put(view, complement) -> instance.
ProtolensChain from_dsl_json(src, body_vertex) / from_dsl_yaml / from_dsl_nickel / from_dsl_path compile a panproto-lens-dsl document into a chain anchored at the named body vertex of the source schema.
MigrationBuilder, compile_migration, compose_migrations Hand-rolled migration construction.
Instance, IoRegistry Parse/emit data across the 50+ supported formats.
Repository Filesystem-backed VCS: init, commit, branch, merge, log, blame, bisect, stash, tag, plus data versioning.
AstParserRegistry, parse_source_file, ParseEmitLens Full-AST parsing across 259 languages via tree-sitter. AstParserRegistry.override_grammar(name, extensions, language_ptr, node_types, ...) swaps a registered grammar at runtime for dev-time grammar work.
Schema.constraints_for, Schema.field_text Read every constraint on a vertex; pull the text of a tree-sitter field('<name>', anonymous-token) child via schema.field_text(vid, "name").
Expr, parse_expr, pretty_print_expr Embedded expression language.

Companion grammar packs

The published panproto wheel ships only the 11 group-core tree-sitter grammars (Python, JavaScript, TypeScript, Java, C#, C++, PHP, Bash, C, Go, Rust). Beyond that, grammars are distributed as separately-installable companion wheels, one per language group:

Wheel Languages
panproto-grammars-web HTML, CSS, JavaScript, TypeScript, TSX, JSON, Vue, Svelte, Astro, GraphQL
panproto-grammars-systems C, C++, Rust, Go, Zig, D, Nim, Odin, V, Hare
panproto-grammars-jvm Java, Kotlin, Scala, Groovy, Clojure
panproto-grammars-scripting Python, Ruby, Lua, Bash, Perl, R, Julia, Nushell, Fish
panproto-grammars-data JSON, TOML, XML, YAML, SQL, CSV, GraphQL, Protobuf
panproto-grammars-functional Haskell, OCaml, Elm, Gleam, Erlang, Elixir, PureScript, F#, Clojure, Scheme, Racket
panproto-grammars-devops Dockerfile, Terraform, HCL, Nix, Bash, YAML, TOML, Make, CMake
panproto-grammars-mobile Swift, Kotlin, Dart, Java, Objective-C
panproto-grammars-music SuperCollider, LilyPond, ABC, Csound, ChucK, Glicol, Tidal mini-notation, Strudel mini-notation
panproto-grammars-all every grammar in panproto-grammars (259 languages)

Install whichever group you need:

pip install panproto-grammars-functional

There is nothing to import from these packages. They register a panproto.grammars entry point on installation; panproto.AstParserRegistry() walks every such entry point and threads the discovered grammar metadata into the native registry on construction. The native class is reachable as panproto._native.AstParserRegistry() for callers who want only the group-core baseline.

How it works under the hood:

  • Each companion is its own pyo3 cdylib depending on panproto-grammars with one group-* feature flag.
  • On import, the companion's grammars_metadata() returns a list of dicts containing the tree-sitter Language pointer plus byte-slice pointer/length pairs (cast to integers for transport across cdylib boundaries).
  • The trust boundary lives on the panproto side, in register_external_from_metadata (crates/panproto-py/src/parse.rs), which decodes the integers back into &'static references and registers a full LanguageParser. The companion's grammar bytes live in its .rodata and stay valid for the process lifetime.
  • A single broken grammar (e.g. an upstream node-types.json with a malformed entry) is skipped with a RuntimeWarning rather than aborting registration; mirrors the resilience of the built-in path.

Performance notes

  • The _native extension talks to the Rust core through PyO3's zero-copy pyclass slabs. Schemas, theories, and lenses are reference-counted Rust objects on the Python side; mutations go through dedicated builder types (SchemaBuilder, MigrationBuilder) that consume on build(), so you can't accidentally observe partial state.
  • Cross-thread sharing of these objects requires the GIL; for parallel work, fan out at the data layer (e.g. parallelise lens.get calls with concurrent.futures) and keep the schema/lens objects per worker.
  • Wheel-load cost is one-time; the import sets up the protocol registry lazily so cold-start is fast.

Contributing

Source: bindings/python. Issues and pull requests at github.com/panproto/panproto/issues.

The native extension lives at crates/panproto-py on the Rust side; bindings/python/src/panproto/__init__.py is the pure-Python re-export layer that maturin ships alongside the compiled extension.

License

MIT © 2026 Aaron Steven White.

Download files

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

Source Distributions

No source distribution files available for this release.See tutorial on generating distribution archives.

Built Distributions

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

panproto-0.64.0-cp313-abi3-win_amd64.whl (12.5 MB view details)

Uploaded CPython 3.13+Windows x86-64

panproto-0.64.0-cp313-abi3-manylinux_2_28_x86_64.whl (11.3 MB view details)

Uploaded CPython 3.13+manylinux: glibc 2.28+ x86-64

panproto-0.64.0-cp313-abi3-manylinux_2_28_aarch64.whl (10.5 MB view details)

Uploaded CPython 3.13+manylinux: glibc 2.28+ ARM64

panproto-0.64.0-cp313-abi3-macosx_11_0_arm64.whl (10.4 MB view details)

Uploaded CPython 3.13+macOS 11.0+ ARM64

panproto-0.64.0-cp313-abi3-macosx_10_12_x86_64.whl (11.1 MB view details)

Uploaded CPython 3.13+macOS 10.12+ x86-64

File details

Details for the file panproto-0.64.0-cp313-abi3-win_amd64.whl.

File metadata

  • Download URL: panproto-0.64.0-cp313-abi3-win_amd64.whl
  • Upload date:
  • Size: 12.5 MB
  • Tags: CPython 3.13+, Windows x86-64
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.14

File hashes

Hashes for panproto-0.64.0-cp313-abi3-win_amd64.whl
Algorithm Hash digest
SHA256 b7931ee7653aa30ea4f7979748651e2700688c64c4174125fa7eb64d28dea52b
MD5 285bf136d781159e01ea1d0462832ed2
BLAKE2b-256 7594542ef01339f8e3e4154f3ee0c744f7d565d05dd59e5fccd4ba46d1b27a7a

See more details on using hashes here.

Provenance

The following attestation bundles were made for panproto-0.64.0-cp313-abi3-win_amd64.whl:

Publisher: python-wheels.yml on panproto/panproto

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

File details

Details for the file panproto-0.64.0-cp313-abi3-manylinux_2_28_x86_64.whl.

File metadata

File hashes

Hashes for panproto-0.64.0-cp313-abi3-manylinux_2_28_x86_64.whl
Algorithm Hash digest
SHA256 ae50335c6c1cf06c87dc8f8474b70f0e42a3b63af584ac9e7b2fc442ef1bd847
MD5 fd5d234f4a46c72ab851372d60f05aff
BLAKE2b-256 e321d3156e243473b8862d27f8d1d40d751bf4ec896b3d3778935ba82de7398a

See more details on using hashes here.

Provenance

The following attestation bundles were made for panproto-0.64.0-cp313-abi3-manylinux_2_28_x86_64.whl:

Publisher: python-wheels.yml on panproto/panproto

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

File details

Details for the file panproto-0.64.0-cp313-abi3-manylinux_2_28_aarch64.whl.

File metadata

File hashes

Hashes for panproto-0.64.0-cp313-abi3-manylinux_2_28_aarch64.whl
Algorithm Hash digest
SHA256 1ff73f79c1b8d0740cb10ab370e2622657c74055fe526bf70465fd97312cc622
MD5 7a087c4f1f4b2313e5ead1173d4f5f00
BLAKE2b-256 0d25c5fa98fc498b993c268f30715cff239cda8bd8b463ed6e33cefd5b525006

See more details on using hashes here.

Provenance

The following attestation bundles were made for panproto-0.64.0-cp313-abi3-manylinux_2_28_aarch64.whl:

Publisher: python-wheels.yml on panproto/panproto

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

File details

Details for the file panproto-0.64.0-cp313-abi3-macosx_11_0_arm64.whl.

File metadata

File hashes

Hashes for panproto-0.64.0-cp313-abi3-macosx_11_0_arm64.whl
Algorithm Hash digest
SHA256 f049d9f33b6775fe06fc26eb3c766585fefea15fc93134122272c196de1723cd
MD5 009df650ef7eaeb314ae2464e4ef9c42
BLAKE2b-256 56682c8f985e642d5017e49a9f850c6284c3130e13eacb359fd03fae0c3aa663

See more details on using hashes here.

Provenance

The following attestation bundles were made for panproto-0.64.0-cp313-abi3-macosx_11_0_arm64.whl:

Publisher: python-wheels.yml on panproto/panproto

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

File details

Details for the file panproto-0.64.0-cp313-abi3-macosx_10_12_x86_64.whl.

File metadata

File hashes

Hashes for panproto-0.64.0-cp313-abi3-macosx_10_12_x86_64.whl
Algorithm Hash digest
SHA256 f4720cc0c9452b7ce85910164ee46baf1f145d9ada0f265fe18c1e9b3da60ce1
MD5 40f5c241ff0535f8fc8051479049ad6d
BLAKE2b-256 1e7cc987e67399e1398b20c8c6ef07d4de2caf6d36747989c257352f2fc84851

See more details on using hashes here.

Provenance

The following attestation bundles were made for panproto-0.64.0-cp313-abi3-macosx_10_12_x86_64.whl:

Publisher: python-wheels.yml on panproto/panproto

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

Release history Release notifications | RSS feed

0.71.0

5 files

0.70.1

5 files

0.70.0

5 files

0.69.1

5 files

0.69.0

5 files

0.68.0

5 files

0.67.0

5 files

0.66.0

5 files

0.65.0

5 files

This release

0.64.0 This release

5 files

0.63.0

5 files

0.62.0

5 files

0.61.0

5 files

0.60.0

5 files

0.59.0

5 files

0.58.0

5 files

0.57.0

5 files

0.56.1

5 files

0.56.0

5 files

0.55.0

5 files

0.54.0

5 files

0.53.0

5 files

0.52.1

5 files

0.52.0

5 files

0.51.0

5 files

0.50.9

5 files

0.50.7

5 files

0.50.6

5 files

0.50.5

5 files

0.50.4

5 files

0.50.3

5 files

0.50.2

5 files

0.50.1

5 files

0.50.0

5 files

0.49.6

5 files

0.49.5

5 files

0.49.4

5 files

0.49.3

5 files

0.49.2

5 files

0.49.1

5 files

0.49.0

5 files

0.48.8

5 files

0.48.7

5 files

0.48.6

5 files

0.48.5

5 files

0.48.4

5 files

0.48.3

5 files

0.48.2

5 files

0.48.1

5 files

0.48.0

5 files

0.47.3

5 files

0.47.2

5 files

0.47.1

5 files

0.47.0

5 files

0.46.1

5 files

0.46.0

5 files

0.45.0

5 files

0.44.0

5 files

0.43.3

5 files

0.43.2

5 files

0.43.1

5 files

0.43.0

5 files

0.42.2

5 files

0.42.1

5 files

0.42.0

5 files

0.40.0

5 files

0.39.0

5 files

0.38.0

5 files

0.37.0

5 files

0.36.0

5 files

0.35.0

5 files

0.34.1

5 files

0.34.0

5 files

0.33.0

5 files

0.32.0

5 files

0.31.0

5 files

0.30.1

5 files

0.30.0

5 files

0.29.1

5 files

0.29.0

5 files

0.28.0

5 files

0.27.3

7 files

0.27.2

7 files

0.27.1

7 files

0.27.0

7 files

0.26.0

7 files

0.25.1

7 files

0.25.0

7 files

0.24.0

7 files

0.23.0

8 files

0.22.1

9 files

0.22.0

9 files

0.21.0

2 files

0.20.0

2 files

0.19.0

2 files

0.18.1

2 files

0.18.0

2 files

0.17.3

2 files

0.17.2

2 files

0.17.1

2 files

0.17.0

2 files

0.16.0

2 files

0.15.0

2 files

0.14.0

1 file

0.13.0

2 files

0.12.0

2 files

0.11.0

2 files

0.10.0

2 files

0.9.0

2 files

0.8.0

2 files

0.7.0

2 files

0.6.0

2 files

0.5.1

2 files

0.5.0

2 files

0.4.0

2 files

0.3.0

2 files

0.2.0

2 files

Supported by

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