Skip to main content

introspection-remote-proto

Python bindings for the introspection dev tunnel wire protocol.

The canonical schema is crates/protocol/proto/remote.proto in this repository — the single source of truth for the WebSocket tunnel between the introspection dev CLI and the cloud-side Data Plane. The Rust CLI codegens it via prost (crates/protocol); this package carries the generated Python protobuf module so the cloud consumes exactly the same contract instead of hand-syncing its own copy.

from introspection_remote_proto import remote_pb2, SCHEMA_VERSION

frame = remote_pb2.Frame()
frame.heartbeat.SetInParent()
wire = frame.SerializeToString()

Regenerating

remote_pb2.py is generated from the canonical .proto — never hand-edited. After changing crates/protocol/proto/remote.proto, regenerate from this directory:

./gen.sh

The script runs protoc --python_out against the canonical proto and writes src/introspection_remote_proto/remote_pb2.py. Keep the protobuf protoc version aligned with the runtime pin in pyproject.toml (protobuf>=5.29,<6); the generated header records the version it was produced with.

Versioning

The package version tracks the schema. SCHEMA_VERSION (mirroring the Rust crate's constant) bumps only on breaking envelope changes; additive, proto3-default-compatible field changes are a minor/patch release that both the CLI and the Data Plane can adopt independently.

Published to PyPI from this repo's release workflow. The Data Plane depends on it (introspection-remote-proto) and re-exports remote_pb2 through introspection_common.remote.

Releases are change-gated: the package publishes a new version only when the schema (or this package) actually changes — it is versioned independently of the CLI, starting at 0.1.0, not on every CLI release.

Download files

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

Source Distribution

introspection_remote_proto-0.1.0.tar.gz (5.3 kB view details)

Uploaded Source

Built Distribution

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

introspection_remote_proto-0.1.0-py3-none-any.whl (6.2 kB view details)

Uploaded Python 3

File details

Details for the file introspection_remote_proto-0.1.0.tar.gz.

File metadata

File hashes

Hashes for introspection_remote_proto-0.1.0.tar.gz
Algorithm Hash digest
SHA256 c93527d821a84ce1b5d1b016de0a515023763a71bf2f9761374c69c12b9675ba
MD5 6f7aa6212278d3ebc9624caa04bb55a3
BLAKE2b-256 f0fbfb5da75ec5652bdf06c0fb7275e6231de69e9e13758f17e5dbcc1c98c160

See more details on using hashes here.

Provenance

The following attestation bundles were made for introspection_remote_proto-0.1.0.tar.gz:

Publisher: release.yml on introspection-org/introspection-cli

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

File details

Details for the file introspection_remote_proto-0.1.0-py3-none-any.whl.

File metadata

File hashes

Hashes for introspection_remote_proto-0.1.0-py3-none-any.whl
Algorithm Hash digest
SHA256 e4773005d2d6194e5c0aabde002ab0cd0c8dde58f66c17eed067578bb4f460ba
MD5 a13f51da951e2bd43a37eb03f3d5a74b
BLAKE2b-256 c5e1db063d153713b06031878b886c451eeb6edc03e136d852b65f9a8473a7de

See more details on using hashes here.

Provenance

The following attestation bundles were made for introspection_remote_proto-0.1.0-py3-none-any.whl:

Publisher: release.yml on introspection-org/introspection-cli

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