Skip to main content

Python client SDK for Schema Registry Service

Project description

Core Registry Client

Python client SDK for interacting with the Schema Registry Service.

Installation

pip install core-registry-client

Quick Start

from core_registry_client import RegistryClient

# Initialize client
client = RegistryClient(base_url="http://localhost:8000")

# Get schema index
index = await client.get_index()

# Fetch specific schema
schema = await client.fetch_schema("v1", "telemetry.FeedbackEvent")

# Negotiate best version
result = await client.negotiate(
    name="telemetry.FeedbackEvent",
    prefer="v2",
    fallback="v1",
)

# Check compatibility
compat = await client.check_compatibility(
    name="telemetry.FeedbackEvent",
    from_track="v1",
    from_version="v1.2.0",
    to_track="v2",
    to_version="v2.0.0",
)

API Reference

RegistryClient

Main client class for interacting with the registry.

Methods

  • get_index() - Get complete registry index
  • fetch_schema(track, name, version=None) - Fetch schema by track and name
  • fetch_schema_by_id(schema_id) - Fetch schema by global ID
  • list_versions(track, name) - List all versions of a schema
  • check_compatibility(name, from_track, from_version, to_track, to_version) - Check compatibility
  • negotiate(name, prefer, fallback, supports_tracks=None) - Negotiate best version
  • upload_schema(...) - Upload schema (requires admin token)
  • sync_schemas(source, ref=None, path=None) - Trigger sync (requires admin token)

Examples

See examples/ directory for more usage examples.

License

MIT License

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

core_registry_client-0.2.0.tar.gz (5.5 kB view details)

Uploaded Source

Built Distribution

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

core_registry_client-0.2.0-py3-none-any.whl (6.1 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: core_registry_client-0.2.0.tar.gz
  • Upload date:
  • Size: 5.5 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.13.2

File hashes

Hashes for core_registry_client-0.2.0.tar.gz
Algorithm Hash digest
SHA256 5d30d5e931a385a7ab71c1a0dc2340f7def34b07277507b6ca05122946fcd339
MD5 4225da3e1f0f673ac7e669c56a9a1c2a
BLAKE2b-256 396a1b92099fe65abdf6d943528c64c3fbd3d246e1d55ea41916d261b6a5b62a

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for core_registry_client-0.2.0-py3-none-any.whl
Algorithm Hash digest
SHA256 30b4dca6161d51f91255388274da6596869977455e8e902e9c9e2146065df341
MD5 3bcec7a035d5de5bcf0c61920d4352a0
BLAKE2b-256 48914ebffc561a31d88de2590c4fec12555105e7dd47d2f1f9ec592b85eecfb2

See more details on using hashes here.

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