Skip to main content

SDK for building VY-CNS organs

Project description

VY Organ SDK (Python)

Python SDK for building VY-CNS organs with Protocol v2 support.

Installation

pip install vy-organ-sdk

Quick Start

from vy_organ_sdk import OrganHandler, HandlerRequest, HandlerResponse
from vy_organ_sdk.transports import ZenohOrganServer

class MyOrgan(OrganHandler):
    version = "1.0.0"
    supported_intents = ["my.organ.hello.v1"]

    def handle(self, request: HandlerRequest) -> HandlerResponse:
        return HandlerResponse.success({"message": "Hello!"})

if __name__ == "__main__":
    import asyncio
    server = ZenohOrganServer(MyOrgan(), organ_id="my-organ")
    asyncio.run(server.start())

Environment Variables

  • ZENOH_CONNECT - Zenoh router endpoints (required)
  • ORGAN_ID - Unique organ identifier
  • ZENOH_CERT_PATH - TLS client certificate path
  • ZENOH_KEY_PATH - TLS client key path
  • ZENOH_CA_PATH - TLS CA certificate path

License

MIT

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

vy_organ_sdk-2.5.2.tar.gz (28.4 kB view details)

Uploaded Source

Built Distribution

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

vy_organ_sdk-2.5.2-py3-none-any.whl (34.0 kB view details)

Uploaded Python 3

File details

Details for the file vy_organ_sdk-2.5.2.tar.gz.

File metadata

  • Download URL: vy_organ_sdk-2.5.2.tar.gz
  • Upload date:
  • Size: 28.4 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.11.14

File hashes

Hashes for vy_organ_sdk-2.5.2.tar.gz
Algorithm Hash digest
SHA256 d0dd4efd5860b6bac04302a977d80997a47f65773a9225c9a1edd501e7e76eda
MD5 0a26cb8c9f7ce3f2a6e537118e26c00a
BLAKE2b-256 2bd097fd65f339ea628ff3efe2bb3860e62981fd274b6219e0880db5bb559c40

See more details on using hashes here.

File details

Details for the file vy_organ_sdk-2.5.2-py3-none-any.whl.

File metadata

  • Download URL: vy_organ_sdk-2.5.2-py3-none-any.whl
  • Upload date:
  • Size: 34.0 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.11.14

File hashes

Hashes for vy_organ_sdk-2.5.2-py3-none-any.whl
Algorithm Hash digest
SHA256 f15e995d6d791787cb6c2a6181a7687071e1f88baef82c889784e1966f47c18c
MD5 134001f0de21ec9d5a35e79b5c498552
BLAKE2b-256 00054ccead37c5797094a81f20b6948cec2c81e9f6deb0852d7a6558fbd3a09b

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