Version 3.0.0

* Updated documentation
* Removed beta classifier
* Removed riemann-client-<python-version> executable

Author: Sam Clements

LICENSE

@@ -1,6 +1,6 @@
 The MIT License (MIT)
 
-Copyright (c) 2013 Sam Clements
+Copyright (c) 2014 Sam Clements
 
 Permission is hereby granted, free of charge, to any person obtaining a copy of
 this software and associated documentation files (the "Software"), to deal in

README.rst

@@ -10,38 +10,57 @@ python-riemann-client
 
 A `Riemann <http://riemann.io/>`_ client and command line tool.
 
-Installation
-------------
+Usage
+-----
 
-::
+As a command line tool::
 
-	pip install riemann-client
+	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.
 
-Usage
------
+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'")
 
-	riemann-client [host] [port] [-t {tcp,udp}] send [-s SERVICE] [-S STATE] [-m METRIC] [...]
+Installation
+------------
 
-See `riemann-client --help` for more options.
+``python-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
 -------
 
-python-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>`_.
+``python-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
 -------
 
-python-riemann-client was written by `Sam Clements <https://github.com/borntyping>`_, while working at `DataSift <https://github.com/datasift>`_.
+``python-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

riemann_client/__init__.py

@@ -1,4 +1,4 @@
 """A Python Riemann client and command line tool"""
 
-__version__ = '3.0.0-beta'
+__version__ = '3.0.0'
 __author__ = 'Sam Clements <[email protected]>'

setup.py

@@ -5,7 +5,7 @@
 
 setuptools.setup(
     name = "riemann-client",
-    version = '3.0.0-beta',
+    version = '3.0.0',
 
     author = "Sam Clements",
     author_email = "[email protected]",
@@ -23,13 +23,12 @@
 
     entry_points = {
         'console_scripts': [
-            'riemann-client = riemann.command:main',
-            'riemann-client-{0}.{1} = riemann.command:main'.format(*sys.version_info)
+            'riemann-client = riemann_client.command:main',
         ]
     },
 
     classifiers = [
-        'Development Status :: 4 - Beta',
+        'Development Status :: 5 - Production/Stable',
         'License :: OSI Approved',
         'License :: OSI Approved :: MIT License',
         'Operating System :: Unix',