{"id":22846264,"url":"https://github.com/borntyping/python-riemann-client","last_synced_at":"2025-08-07T18:13:24.469Z","repository":{"id":12473214,"uuid":"15140243","full_name":"borntyping/python-riemann-client","owner":"borntyping","description":"A Riemann client and command line tool","archived":false,"fork":false,"pushed_at":"2024-03-15T23:03:52.000Z","size":164,"stargazers_count":39,"open_issues_count":1,"forks_count":12,"subscribers_count":4,"default_branch":"master","last_synced_at":"2025-07-02T18:46:04.448Z","etag":null,"topics":["library","protobuf","python","riemann"],"latest_commit_sha":null,"homepage":"http://riemann-client.readthedocs.io/en/latest/","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/borntyping.png","metadata":{"files":{"readme":"README.rst","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2013-12-12T15:53:25.000Z","updated_at":"2024-11-28T16:28:26.000Z","dependencies_parsed_at":"2024-06-19T20:03:37.973Z","dependency_job_id":"a4477ce5-a735-49b4-a1fa-482cd2863d58","html_url":"https://github.com/borntyping/python-riemann-client","commit_stats":{"total_commits":197,"total_committers":11,"mean_commits":17.90909090909091,"dds":0.6649746192893401,"last_synced_commit":"a06a2b4a8e17de9e27066a14dd8014f6626c2073"},"previous_names":[],"tags_count":27,"template":false,"template_full_name":null,"purl":"pkg:github/borntyping/python-riemann-client","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/borntyping%2Fpython-riemann-client","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/borntyping%2Fpython-riemann-client/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/borntyping%2Fpython-riemann-client/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/borntyping%2Fpython-riemann-client/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/borntyping","download_url":"https://codeload.github.com/borntyping/python-riemann-client/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/borntyping%2Fpython-riemann-client/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":269300991,"owners_count":24394081,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","status":"online","status_checked_at":"2025-08-07T02:00:09.698Z","response_time":73,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["library","protobuf","python","riemann"],"created_at":"2024-12-13T03:26:54.665Z","updated_at":"2025-08-07T18:13:24.434Z","avatar_url":"https://github.com/borntyping.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"==============\nriemann-client\n==============\n\n.. image:: http://img.shields.io/pypi/v/riemann-client.svg\n    :target: https://pypi.python.org/pypi/riemann-client\n\n.. image:: http://img.shields.io/pypi/l/riemann-client.svg\n    :target: https://pypi.python.org/pypi/riemann-client\n\n.. image:: http://img.shields.io/travis/borntyping/python-riemann-client/master.svg\n    :target: https://travis-ci.org/borntyping/python-riemann-client\n\n|\n\nA `Riemann \u003chttp://riemann.io/\u003e`_ client library and command line tool for\nPython. It supports UDP and TCP transports, queries, and all metric types.\nThe client library aims to provide a simple, minimal API, and does not\nrequire direct interaction with protocol buffers. There is also a queued\nclient that can queue or batch events and then send them in a single message.\n\n* `Source on GitHub \u003chttps://github.com/borntyping/python-riemann-client\u003e`_\n* `Documentation on Read the Docs \u003chttp://riemann-client.readthedocs.org/en/latest/\u003e`_\n* `Packages on PyPI \u003chttps://pypi.python.org/pypi/riemann-client\u003e`_\n\n**This project is no longer maintained. Please contact me by opening an issue\non the GitHub project if you'd like to fork this repository and take over the\n``riemann-client`` PyPI package.**\n\nUsage\n-----\n\nAs a command line tool::\n\n  riemann-client [--host HOST] [--port PORT] send [-s SERVICE] [-S STATE] [-m METRIC] [...]\n  riemann-client [--host HOST] [--port PORT] query QUERY\n\nThe host and port used by the command line tool can also be set with the\n``RIEMANN_HOST`` and ``RIEMANN_PORT`` environment variables. By default,\n``localhost:5555`` will be used.\n\nAs a library::\n\n  import riemann_client.client\n\n  with riemann_client.client.Client() as client:\n      client.event(service=\"riemann-client\", state=\"awesome\")\n      client.query(\"service = 'riemann-client'\")\n\nA more detailed example, using both a non-default transport and a queued\nclient::\n\n  from riemann_client.transport import TCPTransport\n  from riemann_client.client import QueuedClient\n\n  with QueuedClient(TCPTransport(\"localhost\", 5555)) as client:\n      client.event(service=\"one\", metric_f=0.1)\n      client.event(service=\"two\", metric_f=0.2)\n      client.flush()\n\nThe ``QueuedClient`` class modifies the ``event()`` method to add events to a\nqueue instead of immediately sending them, and adds the ``flush()`` method to\nsend the current event queue as a single message.\n\nInstallation\n------------\n\n``riemann-client`` requires Python 2.6 or above, and can be installed with\n``pip install riemann-client``. It will use Google's `protobuf`_ library when\nrunning under Python 2, and `GreatFruitOmsk`_'s `protobuf-py3`_ fork when\nrunning under Python 3. Python 3 support is experimental and is likely to use\nGoogle's `protobuf` once it supports Python 3 fully.\n\n.. _protobuf: https://pypi.python.org/pypi/protobuf\n.. _GreatFruitOmsk: https://github.com/GreatFruitOmsk\n.. _protobuf-py3: https://pypi.python.org/pypi/protobuf-py3\n\nRequirements\n^^^^^^^^^^^^\n\n* `click \u003chttp://click.pocoo.org/\u003e`_\n* `protobuf`_ (when using Python 2)\n* `protobuf-py3`_ (when using Python 3)\n\nTesting (Linux/OSX)\n-------------------\n\nTesting is done with `tox`_::\n\n    tox\n\n.. _tox: https://tox.readthedocs.org/en/latest/\n\nChangelog\n---------\nVersion 6.1.3\n^^^^^^^^^^^^^\n\n* Added ``--echo/--no-echo`` option to the CLI.\n\nVersion 6.1.2\n^^^^^^^^^^^^^\n\n* Fixed tests inclusion in tarball.\n\nVersion 6.1.1\n^^^^^^^^^^^^^\n\n* Fixed socket error handling in ``riemann_client.client.AutoFlushingQueuedClient``.\n\nVersion 6.1.0\n^^^^^^^^^^^^^\n\n* ``riemann_client.client.AutoFlushingQueuedClient`` added.\n\nVersion 6.0.0\n^^^^^^^^^^^^^\n\n* ``riemann_client.client.Client.create_dict`` only returns event fields that\n  are set on the Protocol Buffers ``Event`` object\n* ``riemann-client send ...`` only outputs fields that were set on the message\n\nVersion 5.1.0\n^^^^^^^^^^^^^\n\n* Added Python 3 support\n* Changed ``riemann_client.riemann_pb2`` to wrap ``_py2`` and ``_py3`` modules\n* Changed ``setup.py`` to dynamically select a ``protobuf`` dependency\n\nVersion 5.0.x\n^^^^^^^^^^^^^\n\n* Added API documentation (http://riemann-client.readthedocs.org/)\n* Replaced ``argparse`` with ``click`` for an improved CLI\n* Various command line parameters changed\n* ``--event-host`` became ``--host``\n* ``--print`` was removed, ``send`` always prints the sent event\n* Minor fixes to ``QueuedClient`` API\n* ``UDPTransport.send`` returns ``None`` instead of ``NotImplemented``\n\nVersion 4.2.x\n^^^^^^^^^^^^^\n\n* Added ``events()`` and ``send_events()`` methods to the client\n* Added ``clear_queue()`` method to the queued client\n* Add ``--timeout`` option for TCP based transports\n\nVersion 4.1.x\n^^^^^^^^^^^^^\n\n* Full Riemann protocol support (TLS transport, event attributes)\n* Fixes for multiple broken features (``--tags``, ``--print``)\n* Raise errors when clients are used incorrectly\n* Client displays errors from Riemann nicely\n* Relaxed version requirements to fit CentOS 6 packages\n\nVersion 3.0.x\n^^^^^^^^^^^^^\n\n* Renamed module from ``riemann`` to ``riemann_client``\n* Command line interface was rewritten, and is now the only part of the library\n  that respects the ``RIEMANN_HOST`` and ``RIEMANN_PORT`` environment variables\n* Support for querying the Riemann index was added\n* Internally, transports now define ``send`` instead of ``write``, and\n  ``TCPTransport.send`` returns Riemann's response message\n\nLicence\n-------\n\n``riemann-client`` is licensed under the `MIT Licence`_. The protocol buffer\ndefinition is sourced from the `Riemann Java client`_, which is licensed under\nthe `Apache Licence`_.\n\n.. _MIT Licence: http://opensource.org/licenses/MIT\n.. _Riemann Java client: https://github.com/aphyr/riemann-java-client/blob/0c4a1a255be6f33069d7bb24d0cc7efb71bf4bc8/src/main/proto/riemann/proto.proto\n.. _Apache Licence: http://www.apache.org/licenses/LICENSE-2.0\n\nAuthors\n-------\n\n``riemann-client`` was written by `Sam Clements\n\u003chttps://github.com/borntyping\u003e`_, while working at `DataSift\n\u003chttps://github.com/datasift\u003e`_.\n\n.. image:: https://0.gravatar.com/avatar/8dd5661684a7385fe723b7e7588e91ee?d=https%3A%2F%2Fidenticons.github.com%2Fe83ef7586374403a328e175927b98cac.png\u0026r=x\u0026s=40\n.. image:: https://1.gravatar.com/avatar/a3a6d949b43b6b880ffb3e277a65f49d?d=https%3A%2F%2Fidenticons.github.com%2F065affbc170e2511eeacb3bd0e975ec1.png\u0026r=x\u0026s=40\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fborntyping%2Fpython-riemann-client","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fborntyping%2Fpython-riemann-client","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fborntyping%2Fpython-riemann-client/lists"}