Metadata-Version: 1.1
Name: riemann-client
Version: 3.0.3
Summary: A Riemann client and command line tool
Home-page: https://github.com/borntyping/python-riemann-client
Author: Sam Clements
Author-email: sam.clements@datasift.com
License: UNKNOWN
Description: ==============
        riemann-client
        ==============
        
        .. image:: https://pypip.in/v/riemann-client/badge.png
            :target: https://pypi.python.org/pypi/riemann-client
        
        .. image:: https://travis-ci.org/borntyping/python-riemann-client.png?branch=master
            :target: https://travis-ci.org/borntyping/python-riemann-client
        
        A `Riemann <http://riemann.io/>`_ client library and command line tool for Python.
        
        Usage
        -----
        
        As a command line tool::
        
        	riemann-client [--host HOST] [--port PORT] send [-s SERVICE] [-S STATE] [-m METRIC] [...]
        	riemann-client [--host HOST] [--port PORT] query '<query>'
        
        The host and port used by the command line tool can also be set with the ``RIEMANN_HOST`` and ``RIEMANN_PORT`` environment variables. By default, ``localhost:5555`` will be used.
        
        As a library::
        
        	import riemann_client.client
        
        	with riemann_client.client.Client() as client:
        		client.event(service='riemann-client', state='awesome')
        		client.query("service = 'riemann-client'")
        
        Installation
        ------------
        
        ``riemann-client`` requires Python 2.6 or 2.7, and can be installed with ``pip install riemann-client``. Python 3 is not supported due to the dependency on the Google `protobuf <https://pypi.python.org/pypi/protobuf>`_ package.
        
        Requirements
        ^^^^^^^^^^^^
        
        * `argparse <https://pypi.python.org/pypi/argparse>`_
        * `protobuf <https://pypi.python.org/pypi/protobuf>`_
        
        Changelog
        ---------
        
        Version numbers use the `semver <http://semver.org/>`_ specification. A new major version indicates breaking changes.
        
        Version 3.0.0
        ^^^^^^^^^^^^^
        
        * Renamed module from ``riemann`` to ``riemann_client``
        * Command line interface was rewritten, and is now the only part of the library that respects the RIEMANN_HOST and RIEMANN_PORT environment variables
        * Support for querying the Riemann index was added
        * Internally, transports now define ``send`` instead of ``write``, and ``TCPTransport.send`` returns Riemann's response message
        
        Licence
        -------
        
        ``riemann-client`` is licensed under the `MIT Licence <http://opensource.org/licenses/MIT>`_. The protocol buffer definition is sourced from the `Riemann Java client <https://github.com/aphyr/riemann-java-client/blob/0c4a1a255be6f33069d7bb24d0cc7efb71bf4bc8/src/main/proto/riemann/proto.proto>`_, which is licensed under the `Apache Licence <http://www.apache.org/licenses/LICENSE-2.0>`_.
        
        Authors
        -------
        
        ``riemann-client`` was written by `Sam Clements <https://github.com/borntyping>`_, while working at `DataSift <https://github.com/datasift>`_.
        
        .. image:: https://0.gravatar.com/avatar/8dd5661684a7385fe723b7e7588e91ee?d=https%3A%2F%2Fidenticons.github.com%2Fe83ef7586374403a328e175927b98cac.png&r=x&s=40
        .. image:: https://1.gravatar.com/avatar/a3a6d949b43b6b880ffb3e277a65f49d?d=https%3A%2F%2Fidenticons.github.com%2F065affbc170e2511eeacb3bd0e975ec1.png&r=x&s=40
        
Platform: UNKNOWN
Classifier: Development Status :: 5 - Production/Stable
Classifier: License :: OSI Approved
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: Unix
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 2
Classifier: Programming Language :: Python :: 2.6
Classifier: Programming Language :: Python :: 2.7
Classifier: Topic :: Software Development :: Libraries
Classifier: Topic :: System :: Monitoring
Classifier: Topic :: System :: Networking
Classifier: Topic :: System :: Systems Administration
