Skip to main content

Helper for interface APIs written for the charm operator framework, which can register them with charms.reactive to function similarly to Endpoints.

Project description

ops-reactive-interface

This library is a helper for developers creating interface protocol API libraries for charms. The goal is to allow the developer to focus on implementing the API library using the best practices from the Operator framework pattern and still enable usage in older charms which have yet to be transitioned from the charms.reactive framework with minimal additional developer and resource overhead.

Usage

All that is required to use this library is to add a bit of info to your interface protocol API library's setup.py to include this as a dependency and to register your API classes with the role and interface protocol name they implement. Full details can be found in the docs, as well as an example which shows an interface API implementation with usage by both an Operator framework charm and a charms.reactive charm.

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

ops_reactive_interface-1.0.1.tar.gz (3.8 kB view hashes)

Uploaded source

Supported by

AWS AWS Cloud computing Datadog Datadog Monitoring Facebook / Instagram Facebook / Instagram PSF Sponsor Fastly Fastly CDN Google Google Object Storage and Download Analytics Huawei Huawei PSF Sponsor Microsoft Microsoft PSF Sponsor NVIDIA NVIDIA PSF Sponsor Pingdom Pingdom Monitoring Salesforce Salesforce PSF Sponsor Sentry Sentry Error logging StatusPage StatusPage Status page