Merge branch 'small-fixes' into feature/v7

Author: borntyping

README.rst

@@ -28,31 +28,31 @@ 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
+  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
+  import riemann_client.client
 
-    with riemann_client.client.Client() as client:
-        client.event(service="riemann-client", state="awesome")
-        client.query("service = 'riemann-client'")
+  with riemann_client.client.Client() as client:
+      client.event(service="riemann-client", state="awesome")
+      client.query("service = 'riemann-client'")
 
 A more detailed example, using both a non-default transport and a queued
 client::
 
-    from riemann_client.transport import TCPTransport
-    from riemann_client.client import QueuedClient
+  from riemann_client.transport import TCPTransport
+  from riemann_client.client import QueuedClient
 
-    with QueuedClient(TCPTransport("localhost", 5555)) as client:
-        client.event(service="one", metric_f=0.1)
-        client.event(service="two", metric_f=0.2)
-        client.flush()
+  with QueuedClient(TCPTransport("localhost", 5555)) as client:
+      client.event(service="one", metric_f=0.1)
+      client.event(service="two", metric_f=0.2)
+      client.flush()
 
 The ``QueuedClient`` class modifies the ``event()`` method to add events to a
 queue instead of immediately sending them, and adds the ``flush()`` method to
@@ -64,7 +64,7 @@ Installation
 ``riemann-client`` requires Python 2.6 or above, and can be installed with
 ``pip install riemann-client``. It will use Google's `protobuf`_ library when
 running under Python 2, and `GreatFruitOmsk`_'s `protobuf-py3`_ fork when
-running under Python 3. Python 3 support is experimental and is likley to use
+running under Python 3. Python 3 support is experimental and is likely to use
 Google's `protobuf` once it supports Python 3 fully.
 
 .. _protobuf: https://pypi.python.org/pypi/protobuf
@@ -79,7 +79,7 @@ Requirements
 * `protobuf-py3`_ (when using Python 3)
 
 Testing (Linux/OSX)
--------
+-------------------
 
 Testing is done with `tox`_::
 

riemann_client/__init__.py

@@ -1,4 +1,19 @@
 """A Python Riemann client and command line tool"""
 
-__version__ = '6.1.3'
+from .client import (
+    Client, QueuedClient  # noqa
+)
+
+from .transport import (
+    RiemannError, SocketTransport, UDPTransport,  # noqa
+    TCPTransport, TLSTransport, BlankTransport,   # noqa
+)
+
+
+try:
+    from .client import AutoFlushingQueuedClient  # noqa
+except ImportError:
+    pass
+
+__version__ = '6.4.0'
 __author__ = 'Sam Clements <sam.clements@datasift.com>'

riemann_client/__main__.py

@@ -0,0 +1,9 @@
+"""Riemann command line client"""
+
+from __future__ import absolute_import
+
+from . import command
+
+
+if __name__ == '__main__':
+    command.main()

riemann_client/client.py

@@ -24,8 +24,8 @@ def emit(self, record):
     Timer = None
 import time
 
-import riemann_client.riemann_pb2
-import riemann_client.transport
+from . import riemann_pb2
+from .transport import UDPTransport, TCPTransport
 
 logger = logging.getLogger(__name__)
 logger.addHandler(NullHandler())
@@ -64,7 +64,7 @@ class Client(object):
 
     def __init__(self, transport=None):
         if transport is None:
-            transport = riemann_client.transport.TCPTransport()
+            transport = TCPTransport()
         self.transport = transport
 
     def __enter__(self):
@@ -81,7 +81,7 @@ def create_event(data):
         :param dict data: The attributes to be set on the event
         :returns: A protocol buffer ``Event`` object
         """
-        event = riemann_client.riemann_pb2.Event()
+        event = riemann_pb2.Event()
         event.host = socket.gethostname()
         event.tags.extend(data.pop('tags', []))
 
@@ -100,7 +100,7 @@ def send_events(self, events):
         :param events: A list or iterable of ``Event`` objects
         :returns: The response message from Riemann
         """
-        message = riemann_client.riemann_pb2.Msg()
+        message = riemann_pb2.Msg()
         for event in events:
             message.events.add().MergeFrom(event)
         return self.transport.send(message)
@@ -160,7 +160,7 @@ def send_query(self, query):
 
         :returns: The response message from Riemann
         """
-        message = riemann_client.riemann_pb2.Msg()
+        message = riemann_pb2.Msg()
         message.query.string = query
         return self.transport.send(message)
 
@@ -172,7 +172,7 @@ def query(self, query):
         :returns: A list of event dictionaries taken from the response
         :raises Exception: if used with a :py:class:`.UDPTransport`
         """
-        if isinstance(self.transport, riemann_client.transport.UDPTransport):
+        if isinstance(self.transport, UDPTransport):
             raise Exception('Cannot query the Riemann server over UDP')
         response = self.send_query(query)
         return [self.create_dict(e) for e in response.events]
@@ -218,7 +218,7 @@ def send_events(self, events):
 
     def clear_queue(self):
         """Resets the message/queue to a blank :py:class:`.Msg` object"""
-        self.queue = riemann_client.riemann_pb2.Msg()
+        self.queue = riemann_pb2.Msg()
 
 
 if RLock and Timer:  # noqa
@@ -363,3 +363,6 @@ def stop_timer(self):
             a :py:meth:`.flush` event will reactviate the timer
             """
             self.timer.cancel()
+
+
+__all__ = 'Client', 'QueuedClient', 'AutoFlushingQueuedClient'

riemann_client/command.py

@@ -7,20 +7,23 @@
 
 import click
 
-import riemann_client
-import riemann_client.client
-import riemann_client.transport
+from . import __version__
+from .client import Client
+from .transport import (
+    RiemannError, UDPTransport, TCPTransport,
+    TLSTransport, BlankTransport
+)
 
 __all__ = ['main']
 
 
-class CommandLineClient(riemann_client.client.Client):
+class CommandLineClient(Client):
     """Prints to STDERR when an error message is recived from Riemann"""
 
     def __exit__(self, exc_type, exc_value, traceback):
         super(CommandLineClient, self).__exit__(exc_type, exc_value, traceback)
 
-        if isinstance(exc_type, riemann_client.transport.RiemannError):
+        if isinstance(exc_type, RiemannError):
             click.echo("The server responded with an error: {0}".format(
                 exc_value.message), file=sys.stderr)
             exit(1)
@@ -41,7 +44,7 @@ def echo_event(data):
 
 
 @click.group()
-@click.version_option(version=riemann_client.__version__)
+@click.version_option(version=__version__)
 @click.option('--host', '-H', type=click.STRING, default='localhost',
               envvar='RIEMANN_HOST', help='Riemann server hostname.')
 @click.option('--port', '-P', type=click.INT, default=5555,
@@ -67,16 +70,16 @@ def main(ctx, host, port, transport_type, timeout, ca_certs):
     if transport_type == 'udp':
         if timeout is not None:
             ctx.fail('--timeout cannot be used with the UDP transport')
-        transport = riemann_client.transport.UDPTransport(host, port)
+        transport = UDPTransport(host, port)
     elif transport_type == 'tcp':
-        transport = riemann_client.transport.TCPTransport(host, port, timeout)
+        transport = TCPTransport(host, port, timeout)
     elif transport_type == 'tls':
         if ca_certs is None:
             ctx.fail('--ca-certs must be set when using the TLS transport')
-        transport = riemann_client.transport.TLSTransport(
+        transport = TLSTransport(
             host, port, timeout, ca_certs)
     elif transport_type == 'none':
-        transport = riemann_client.transport.BlankTransport()
+        transport = BlankTransport()
 
     ctx.obj = transport
 

riemann_client/riemann_pb2.py

@@ -1,10 +1,10 @@
-"""Wraps the riemann_pb2_py2 and riemann_pb2_py3 modules"""
+"""Wraps the riemann_py2_pb2 and riemann_py3_pb2 modules"""
 
 import sys
 
 __all__ = ['Event', 'Msg', 'Query', 'Attribute']
 
 if sys.version_info >= (3,):
-    from riemann_client.riemann_py3_pb2 import (Event, Msg, Query, Attribute)
+    from .riemann_py3_pb2 import (Event, Msg, Query, Attribute)
 else:
-    from riemann_client.riemann_py2_pb2 import (Event, Msg, Query, Attribute)
+    from .riemann_py2_pb2 import (Event, Msg, Query, Attribute)

riemann_client/transport.py

@@ -9,7 +9,7 @@
 import ssl
 import struct
 
-import riemann_client.riemann_pb2
+from . import riemann_pb2
 
 
 # Default arguments
@@ -138,7 +138,7 @@ def send(self, message):
         self.socket.sendall(struct.pack('!I', len(message)) + message)
 
         length = struct.unpack('!I', self.socket.recv(4))[0]
-        response = riemann_client.riemann_pb2.Msg()
+        response = riemann_pb2.Msg()
         response.ParseFromString(socket_recvall(self.socket, length))
 
         if not response.ok:
@@ -190,7 +190,7 @@ def send(self, message):
         """
         for event in message.events:
             self.events.append(event)
-        reply = riemann_client.riemann_pb2.Msg()
+        reply = riemann_pb2.Msg()
         reply.ok = True
         return reply
 
@@ -200,3 +200,9 @@ def disconnect(self):
 
     def __len__(self):
         return len(self.events)
+
+
+__all__ = (
+    'RiemannError', 'SocketTransport', 'UDPTransport',
+    'TCPTransport', 'TLSTransport', 'BlankTransport',
+)

setup.py

@@ -11,7 +11,7 @@
 
 setuptools.setup(
     name='riemann-client',
-    version='6.5.0',
+    version='6.6.0',
 
     author="Sam Clements",
     author_email="sam.clements@datasift.com",