Skip to content

Commit 8894179

Browse files
author
Sam Clements
committed
Version 3.0.0
* Updated documentation * Removed beta classifier * Removed riemann-client-<python-version> executable
1 parent 276cce7 commit 8894179

File tree

4 files changed

+36
-18
lines changed

4 files changed

+36
-18
lines changed

LICENSE

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
The MIT License (MIT)
22

3-
Copyright (c) 2013 Sam Clements
3+
Copyright (c) 2014 Sam Clements
44

55
Permission is hereby granted, free of charge, to any person obtaining a copy of
66
this software and associated documentation files (the "Software"), to deal in

README.rst

Lines changed: 31 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -10,38 +10,57 @@ python-riemann-client
1010

1111
A `Riemann <http://riemann.io/>`_ client and command line tool.
1212

13-
Installation
14-
------------
13+
Usage
14+
-----
1515

16-
::
16+
As a command line tool::
1717

18-
pip install riemann-client
18+
riemann-client [--host HOST] [--port PORT] send [-s SERVICE] [-S STATE] [-m METRIC] [...]
19+
riemann-client [--host HOST] [--port PORT] query '<query>'
1920

21+
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.
2022

21-
Usage
22-
-----
23+
As a library::
24+
25+
import riemann_client.client
2326

24-
::
27+
with riemann_client.client.Client() as client:
28+
client.event(service='riemann-client', state='awesome')
29+
client.query("service = 'riemann-client'")
2530

26-
riemann-client [host] [port] [-t {tcp,udp}] send [-s SERVICE] [-S STATE] [-m METRIC] [...]
31+
Installation
32+
------------
2733

28-
See `riemann-client --help` for more options.
34+
``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.
2935

3036
Requirements
31-
------------
37+
^^^^^^^^^^^^
3238

3339
* `argparse <https://pypi.python.org/pypi/argparse>`_
3440
* `protobuf <https://pypi.python.org/pypi/protobuf>`_
3541

42+
Changelog
43+
---------
44+
45+
Version numbers use the `semver <http://semver.org/>`_ specification. A new major version indicates breaking changes.
46+
47+
Version 3.0.0
48+
^^^^^^^^^^^^^
49+
50+
* Renamed module from ``riemann`` to ``riemann_client``
51+
* Command line interface was rewritten, and is now the only part of the library that respects the RIEMANN_HOST and RIEMANN_PORT environment variables
52+
* Support for querying the Riemann index was added
53+
* Internally, transports now define ``send`` instead of ``write``, and ``TCPTransport.send`` returns Riemann's response message
54+
3655
Licence
3756
-------
3857

39-
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>`_.
58+
``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>`_.
4059

4160
Authors
4261
-------
4362

44-
python-riemann-client was written by `Sam Clements <https://github.com/borntyping>`_, while working at `DataSift <https://github.com/datasift>`_.
63+
``python-riemann-client`` was written by `Sam Clements <https://github.com/borntyping>`_, while working at `DataSift <https://github.com/datasift>`_.
4564

4665
.. image:: https://0.gravatar.com/avatar/8dd5661684a7385fe723b7e7588e91ee?d=https%3A%2F%2Fidenticons.github.com%2Fe83ef7586374403a328e175927b98cac.png&r=x&s=40
4766
.. image:: https://1.gravatar.com/avatar/a3a6d949b43b6b880ffb3e277a65f49d?d=https%3A%2F%2Fidenticons.github.com%2F065affbc170e2511eeacb3bd0e975ec1.png&r=x&s=40

riemann_client/__init__.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
11
"""A Python Riemann client and command line tool"""
22

3-
__version__ = '3.0.0-beta'
3+
__version__ = '3.0.0'
44
__author__ = 'Sam Clements <[email protected]>'

setup.py

Lines changed: 3 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@
55

66
setuptools.setup(
77
name = "riemann-client",
8-
version = '3.0.0-beta',
8+
version = '3.0.0',
99

1010
author = "Sam Clements",
1111
author_email = "[email protected]",
@@ -23,13 +23,12 @@
2323

2424
entry_points = {
2525
'console_scripts': [
26-
'riemann-client = riemann.command:main',
27-
'riemann-client-{0}.{1} = riemann.command:main'.format(*sys.version_info)
26+
'riemann-client = riemann_client.command:main',
2827
]
2928
},
3029

3130
classifiers = [
32-
'Development Status :: 4 - Beta',
31+
'Development Status :: 5 - Production/Stable',
3332
'License :: OSI Approved',
3433
'License :: OSI Approved :: MIT License',
3534
'Operating System :: Unix',

0 commit comments

Comments
 (0)