Skip to main content

Python client for Consul.io

Documentation

Read the Docs

Status

Build StatusCoverage Status

Example

import consul

c = consul.Consul()

# poll a key for updates
index = None
while True:
    index, data = c.kv.get('foo', index=index)
    print data['Value']

# in another process
c.kv.put('foo', 'bar')

Installation

pip install python-consul

Status

There’s a few API endpoints still to go to expose all features available in Consul v0.5.0. If you need an endpoint that’s not in the documentation, just open an issue and I’ll try and add it straight away.

Change log

0.3.11

Features

  • add the health.state endpoint (thanks @pete0emerson!)

  • bump test binaries to 0.5.0

0.3.9

Bug Fix

  • Exclude consul.aio if asyncio isn’t available, avoids an error message on install, trying to byte compile that module

0.3.8

API changes (backwards incompatible)

  • Reorder named arguments to be more consistent. index is always the first named argument, if available, and dc is now always the last named argument.

0.3.7

Features

  • Add dc support for kv calls; add ability to set the default dc for an entire client session (thanks @angad)

  • Add asyncio client (thanks @jettify)

0.3.6

Features

  • Add https support (thanks @pete0emerson)

  • Add wan param to agent.members (thanks @sgargan)

0.3.5

Bug Fix

  • Fix typo setting notes on a check (thanks @ShaheedHaque!)

0.3.4

Features

  • Add support for the Agent.Check (thanks @sgargan and @ShaheedHaque)

Deprecated

  • health.check.ttl_pass has been moved to agent.check.ttl_pass

0.3.3

Features

  • Add support for the Session API (Consul.Session)

Bug Fixes

0.3.2

Features

  • Add support for Python 3.4

0.3.1

Features

  • Add support for the Catalog API (Consul.Catalog)

  • Add ability to set a default consistency mode for an entire client session

  • Add the ability to pass the consistency mode with kv.get

0.3.0

Features

  • Add support for ACLs (Consul.ACL)

API changes (backwards incompatible)

  • For Consul.Agent.Service.register, rename check argument to script

Metadata

Release files for python-consul 0.3.11

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for python-consul 0.3.11
File Size Uploaded
python-consul-0.3.11.tar.gz 13.3 kB Details

Release files / python-consul-0.3.11.tar.gz

Download URL python-consul-0.3.11.tar.gz
Size 13.3 kB
Tags Source
SHA-256 checksum
How to use checksums
1811edc42dad6265fbc36208688beddb76e0c4b6cc44155bac7581bf67170962
BLAKE2b-256 checksum
How to use checksums
b47159d9e837bb89560af077664b9cc56787b9ae2c3aafe8623bf5e0f87e6ce7
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No

Release history Release notifications | RSS feed

1.1.0

2 release files

1.0.1

1 release file

1.0.0

2 release files

0.7.2

2 release files

0.7.1

1 release file

0.7.0

1 release file

0.6.2

1 release file

0.6.1

1 release file

0.6.0

1 release file

0.4.7

1 release file

0.4.6

1 release file

0.4.5

1 release file

0.4.4

1 release file

0.4.3

1 release file

0.4.2

1 release file

0.4.1

1 release file

0.4.0

1 release file

0.3.20

1 release file

0.3.19

1 release file

0.3.18

1 release file

0.3.17

1 release file

0.3.16

1 release file

0.3.15

1 release file

0.3.14

1 release file

0.3.13

1 release file

0.3.12

1 release file

This release

0.3.11 This release

1 release file

0.3.10

1 release file

0.3.9

1 release file

0.3.8

1 release file

0.3.7

1 release file

0.3.6

1 release file

0.3.5

1 release file

0.3.4

1 release file

0.3.3

1 release file

0.3.2

1 release file

0.3.1

1 release file

0.3.0

1 release file

0.2.0

1 release file

0.1

1 release file

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page