No description, website, or topics provided.
Branch: master
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
examples
kubemq
protos/kubemq/grpc
scripts
.gitignore
LICENSE
README.md
requirements.grpc.txt
requirements.txt
setup.py

README.md

KubeMQ SDK for Python

The KubeMQ SDK for Python enables Python developers to easily work with KubeMQ.

Getting Started

Prerequisites

KubeMQ-SDK-Java works with Python 2.7 or newer.

Installing

The recommended way to use the SDK for Python in your project is to consume it from pip.

pip install kubemq

Generating Documentation

Sphinx is used for documentation. Use the Makefile to build the docs, like so:

$ pip install -r requirements-docs.txt
$ cd docs
$ make html

(make latex or make linkcheck supported)

Building from source

Once you check out the code from GitHub, you can install the package locally with:

$ pip install .

You can also install the package with a symlink, so that changes to the source files will be immediately available:

$ pip install -e .

Running the examples

The examples are standalone projects that showcase the usage of the SDK.

To run the examples you need to have a running instance of KubeMQ.

The following example available under the /examples dir:

  • command-query-channel.py - Initiate a Command Query on a channel
  • command-query-initator.py - Initiate a Command Query
  • command-query-responder.py - Respond to Command Queries
  • event-channel.py - Send event to KubeMQ on a channel
  • event-sender.py - Send event to KubeMQ
  • event-sender-stream.py - Stream event to KubeMQ
  • event-subscriber.py - Subscribe to KubeMQ events

Built With

License

This project is licensed under the MIT License - see the LICENSE file for details