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.4.7

Features

  • Add ACL token support to agent.service.register and agent.check.register

0.4.6

Features

  • Add health.checks endpoint, update health TODOs (thanks @cruatta!)

  • Improve error when a HTTP 503 status code is returned (thanks @raboof!)

  • Added index and wait parameter to event.list (thanks @max0d41!)

0.4.5

Features

  • Allow SSL certificate verification to be disabled (thanks @jgadling!)

  • Use requests.session for performance (thanks @msabramo!)

  • Support ‘wait’ param for all blocking queries (thanks @rmt!)

  • deduplicate query string when doing deletes with the std (requests) library (thanks @sduthil!)

0.4.4

Features

  • Support creation of ALCs with explicit ID. (thanks @KyleJamesWalker)

0.4.3

Features

  • Support ‘dc’ argument to health endpoints (thanks @etuttle!)

0.4.2

Features

  • Add status endpoints (thanks @cruatta!)

0.4.1

Features

  • Add health.node (thanks @davidbirdsong!)

0.4.0

API changes (backwards incompatible)

  • Deprecated old health.check.ttl_pass call has been removed

  • Deprecate loose parameters script, interval, ttl, http and timeout, to configure checks via agent.service.register and agent.check.register. Both methods now take a single argument to specify checks. A convenience consul.Check has been added to create checks.

0.3.20

Features

  • Add Node and Service Maintenance (thanks @cruatta!)

Bug Fix

  • Unclosed connector Exception in consul.aio (thanks @jettify!)

0.3.19

Bug Fix

  • Fix six dependency (thanks @pawlowskimichal!)

0.3.18

Features

  • Adding ability to register checks with services (thanks @cruatta!)

Bug Fix

  • Fix distribution for consul.aio for python3 (thanks @mbachry!)

0.3.17

Features

  • Add address param to agent.service.register

0.3.16

Features

  • Add cas param for kv.delete (thanks @qix)

0.3.15

Features

  • Add tag parameter to health.service() (thanks @reversefold)

0.3.14

Features

  • add the keys and separator params to kv.get (thanks @Heuriskein)

  • add support for the events api (thanks @Heuriskein!)

0.3.13

Features

  • add HTTP check support (thanks @JoeHazzers)

  • raise ConsulException on kv.get 500 response code (thanks @jjpersch)

  • add the wait argument to kv.get

0.3.12

Features

  • add behavior and ttl to session.create

  • add session.renew

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

Release files for python-consul 0.4.7

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.4.7
File Size Uploaded
python-consul-0.4.7.tar.gz 18.3 kB Details

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

Download URL python-consul-0.4.7.tar.gz
Size 18.3 kB
Tags Source
SHA-256 checksum
How to use checksums
e74da67a919ffda6d8b29dec1b090061d4a7409a4b085be6cd13d910e88360ed
BLAKE2b-256 checksum
How to use checksums
44f1ce1cebffddd0847fdd8cc5caab9beda85d83987ba42a146247724eb9e0c9
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

This release

0.4.7 This release

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

0.3.11

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