serfclient

The Python interface to Serf, the decentralised solution for service discovery and orchestration.

.. image:: https://secure.travis-ci.org/KushalP/serfclient-py.png?branch=master :alt: Travis-CI badge :target: http://travis-ci.org/KushalP/serfclient-py .. image:: https://badge.fury.io/py/serfclient.svg :alt: PyPI latest version badge :target: https://pypi.python.org/pypi/serfclient .. image:: https://coveralls.io/repos/KushalP/serfclient-py/badge.png?branch=master :alt: Code coverage badge :target: https://coveralls.io/r/KushalP/serfclient-py?branch=master

Installation

serfclient requires a running Serf agent. See Serf's agent documentation <http://www.serfdom.io/docs/agent/basics.html>_ for instructions.

To install serfclient, run the following command:

.. code-block:: bash

$ pip install serfclient

or alternatively (you really should be using pip though):

.. code-block:: bash

$ easy_install serfclient

or from source:

.. code-block:: bash

$ python setup.py install

Getting Started

.. code-block:: python

from contextlib import closing
from serfclient.client import SerfClient

with closing(SerfClient()) as client:
    client.event('foo', 'bar')

Stream usage:

.. code-block:: python

from contextlib import closing
from serfclient.client import SerfClient

with closing(SerfClient(timeout=None)) as client:
    for response in client.stream('*').body:
        print(response)

Development

serfclient requires a running Serf agent. See Serf's agent documentation <http://www.serfdom.io/docs/agent/basics.html>_ for instructions.

You can run the tests using the following commands:

.. code-block:: bash

$ serf agent --tag foo=bar  # start serf agent
$ python setup.py test