README.rst

serfclient

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

Installation

serfclient requires a running Serf agent. See Serf's agent documentation for instructions.

To install serfclient, run the following command:

$ pip install serfclient

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

$ easy_install serfclient

or from source:

$ python setup.py install

Getting Started

from contextlib import closing
from serfclient.client import SerfClient

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

Stream usage:

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 for instructions.

You can run the tests using the following commands:

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