Cherami Python Client Library
Project description
.. image:: https://travis-ci.org/uber/cherami-client-python.svg?branch=master
:target: https://travis-ci.org/uber/cherami-client-python
.. image:: https://coveralls.io/repos/github/uber/cherami-client-python/badge.svg?branch=master
:target: https://coveralls.io/github/uber/cherami-client-python?branch=master
===============================
Cherami Client For Python
===============================
Python client library for publishing/consuming messages to/from `Cherami <https://github.com/uber/cherami-server>`_.
Installation
------------
``pip install cherami-client``
Usage
-----
Create and edit the ``.yaml`` file under ``./config``
See Example:
::
cat ./config/test.yaml
Set the clay environment variable:
::
export CLAY_CONFIG=./config/test.yaml
Run the example client:
::
python ./demo/example_publisher,py
python ./demo/example_consumer.py
Contributing
------------
We'd love your help in making Cherami great. If you find a bug or need a new feature, open an issue and we will respond as fast as we can.
If you want to implement new feature(s) and/or fix bug(s) yourself, open a pull request with the appropriate unit tests and we will merge it after review.
Note: All contributors also need to fill out the `Uber Contributor License Agreement <http://t.uber.com/cla>`_ before we can merge in any of your changes.
Documentation
-------------
Interested in learning more about Cherami? Read the blog post: `eng.uber.com/cherami <https://eng.uber.com/cherami/>`_
License
-------
MIT License, please see `LICENSE <https://github.com/uber/cherami-client-python/blob/master/LICENSE>`_ for details.
:target: https://travis-ci.org/uber/cherami-client-python
.. image:: https://coveralls.io/repos/github/uber/cherami-client-python/badge.svg?branch=master
:target: https://coveralls.io/github/uber/cherami-client-python?branch=master
===============================
Cherami Client For Python
===============================
Python client library for publishing/consuming messages to/from `Cherami <https://github.com/uber/cherami-server>`_.
Installation
------------
``pip install cherami-client``
Usage
-----
Create and edit the ``.yaml`` file under ``./config``
See Example:
::
cat ./config/test.yaml
Set the clay environment variable:
::
export CLAY_CONFIG=./config/test.yaml
Run the example client:
::
python ./demo/example_publisher,py
python ./demo/example_consumer.py
Contributing
------------
We'd love your help in making Cherami great. If you find a bug or need a new feature, open an issue and we will respond as fast as we can.
If you want to implement new feature(s) and/or fix bug(s) yourself, open a pull request with the appropriate unit tests and we will merge it after review.
Note: All contributors also need to fill out the `Uber Contributor License Agreement <http://t.uber.com/cla>`_ before we can merge in any of your changes.
Documentation
-------------
Interested in learning more about Cherami? Read the blog post: `eng.uber.com/cherami <https://eng.uber.com/cherami/>`_
License
-------
MIT License, please see `LICENSE <https://github.com/uber/cherami-client-python/blob/master/LICENSE>`_ for details.
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
cherami-client-1.0.1.tar.gz
(16.6 kB
view hashes)
Built Distribution
Close
Hashes for cherami_client-1.0.1-py2-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | e7062410a42ac08294db85db36b57267a66b132b393b6a71da7d3c4c71d9c5a9 |
|
MD5 | c8cf28c383b384cf3debed8ea9825d56 |
|
BLAKE2b-256 | f0154ab1ec71ccaf3cea4539047b03eb004f5ef2559f3ff540ef1971936a73e7 |