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.2.0.tar.gz (5.6 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.2.0-py3-none-any.whl (6.5 kB view details)

Uploaded Python 3

File details

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

File metadata

File hashes

Hashes for introspection_remote_proto-0.2.0.tar.gz
Algorithm Hash digest
SHA256 38b46d82e985714ff50ea24d2139d04f737cc58fb8a3dd9692740e850dfa9271
MD5 2c68db8c4b9ac7a3f901bf100c4fcd65
BLAKE2b-256 dfe3f9f9788e944d51eb69ae9e7f9361fb687265c2106107be6102692e01b34f

See more details on using hashes here.

Provenance

The following attestation bundles were made for introspection_remote_proto-0.2.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.2.0-py3-none-any.whl.

File metadata

File hashes

Hashes for introspection_remote_proto-0.2.0-py3-none-any.whl
Algorithm Hash digest
SHA256 0b83a5b5f6a154044db49fc16fea42324d82d72f0b15648e09b52408cfe901cc
MD5 b62ed6abe24d02d671668de6dcd9bc82
BLAKE2b-256 3380578289714558793990cf3fda0566573c140184dd25445991897ed7193978

See more details on using hashes here.

Provenance

The following attestation bundles were made for introspection_remote_proto-0.2.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