Skip to main content
Python Software Foundation 20th Year Anniversary Fundraiser  Donate today!

Python client for Consul (

Project description


[![Latest Version](](
[![Build Status](](
[![Coverage Status](](
[![Requirements Status](](

> Python client for [Consul][1]

A dummy, one-file implementation on top of the [HTTP API][5] of Consul.


* Install Consul following [the official guide][3], or this one-liner:

$ # Install consul 0.1.0_linux_amd64 under /usr/local/bin
$ wget -qO- | (sudo) bash

* Install pyconsul library

$ (sudo) pip install pyconsul

Getting started

I strongly advise you to go through [the official Consul documentation][4]
before playing around with pyconsul.

First, we need an agent in server mode.

consul agent -server -bootstrap \
-data-dir /tmp/consul \
-node=agent-one \
-client= \

Optionally, on different hosts, launch more consul agents in client mode.

$ # Replace with the address provided above to `--client`
$ consul agent --join -data-dir /tmp/consul

Then you can interact with them it.

from pyconsul.http import Consul

# `host` meets `-client <host>` arg of consul (default to
consul_ = Consul(host='', port=8500)
print consul_.status

# Access key / value storage
consul_.set('node/name', 'test')

# Or manage local agent (incomplete)
print consul_.local_agent.members

... in construction ...


Copyright 2014 Xavier Bruhiere.

PyConsul is available under the [MIT Licence][2].


Project details

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Files for pyconsul, version 0.0.2
Filename, size File type Python version Upload date Hashes
Filename, size pyconsul-0.0.2.tar.gz (4.2 kB) File type Source Python version None Upload date Hashes View

Supported by

AWS AWS Cloud computing Datadog Datadog Monitoring DigiCert DigiCert EV certificate Facebook / Instagram Facebook / Instagram PSF Sponsor Fastly Fastly CDN Google Google Object Storage and Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Salesforce Salesforce PSF Sponsor Sentry Sentry Error logging StatusPage StatusPage Status page