Skip to main content

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

.. image:: https://badge.fury.io/py/cherami-client.svg
:target: https://badge.fury.io/py/cherami-client

===============================
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

This version
History Node

1.0.3

History Node

1.0.2

History Node

1.0.1

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Filename, size & hash SHA256 hash help File type Python version Upload date
cherami_client-1.0.3-py2-none-any.whl (30.8 kB) Copy SHA256 hash SHA256 Wheel py2 Aug 29, 2017
cherami_client-1.0.3-py2.py3-none-any.whl (30.8 kB) Copy SHA256 hash SHA256 Wheel py2.py3 Sep 1, 2017
cherami-client-1.0.3.tar.gz (16.8 kB) Copy SHA256 hash SHA256 Source None Aug 29, 2017

Supported by

Elastic Elastic Search Pingdom Pingdom Monitoring Google Google BigQuery Sentry Sentry Error logging CloudAMQP CloudAMQP RabbitMQ AWS AWS Cloud computing Fastly Fastly CDN DigiCert DigiCert EV certificate StatusPage StatusPage Status page