Python client for Consul.io

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-consul2

Note: When using python-consul library in environment with proxy server, setting of http_proxy, https_proxy and no_proxy environment variables can be required for proper functionality.

Status

This python-consul author may be a little busy, I will maintain a version python-consul2, welcome to use. The new consul version was used(v1.6.1). Progressively implement all API interfaces in the future

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

Mailing List

373251686@qq.com

Contributing

python-consul2 is currently maintained by:

@poppyred

Please reach out if you’re interested in being a maintainer as well. Otherwise, open a PR or Issue we’ll try and respond as quickly as we’re able.

Issue Labels

today!:: Some triaging is in progress and this issue should be taken care of in a couple of hours!
priority:: There’s a clear need to address this issue and it’s likely a core contributor will take it on. Opening a PR for these is greatly appreciated!
help wanted:: This issue makes sense and would be useful. It’s unlikely a core contributor will get to this though, so if you’d like to see it addressed please open a PR.
question:: The need for the issue isn’t clear or needs clarification, so please follow up. Issues in this state for a few months, without responses will likely will be closed.

PRs

Pull requests are very much appreciated! When you create a PR please ensure:

All current tests pass, including flake8
To add tests for your new features, if reasonable
To add docstrings for new api features you add and if needed link to these docstrings from the sphinx documentation

Releases

# release the current version, eg: 0.6.1-dev -> 0.6.1
bumpversion release

# prepare the next patch (z-stream) version, eg: 0.6.1 -> 0.6.2-dev
bumpversion --no-tag patch

# else, prepare the next minor (y-stream) version, eg: 0.6.1 -> 0.7.0-dev
bumpversion --no-tag minor

Change log

0.0.1

Features

forked from cablehead/python-consul
Fix Consul.ACL support

0.0.4

Features

implement Connect Config Snapshot consul_api

0.0.5

Features

implement all consul http-api

0.0.8

Features

Add TLSSkipVerify for HTTPS check <bhuisgen@hbis.fr>

0.0.16

Features

Timeout added to http requests <https://github.com/poppyred/python-consul2/pull/4>
Handle CONSUL_HTTP_ADDR including a http:// or https:// scheme <https://github.com/poppyred/python-consul2/pull/3>

0.0.17

Features

removes the WriteRequest in the json body where used. <https://www.consul.io/docs/upgrade-specific.html#stricter-json-decoding>
refactors the api token to use the X-Consul-Token header instead of a parameter, which is recommended and more secure.
Fix catalog.register node_meta in data not in params <https://github.com/poppyred/python-consul2/issues/11>
Fix #7 #9 #10 #11

0.1.0

Features

long_description has syntax errors in markup and would not be rendered on PyPI.

0.1.3

Features

Support SkipNodeUpdate parameter

Metadata

Release files for python-consul2 0.1.5

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-consul2 0.1.5
File	Size	Uploaded
python-consul2-0.1.5.tar.gz	31.4 kB	Oct 20, 2020	Details

Built distribution (wheel)

Table of built distributions (wheels) for python-consul2 0.1.5
File	Interpreter	ABI	Platform	Reset
python_consul2-0.1.5-py2.py3-none-any.whl 30.0 kB Oct 20, 2020	Python 3, Python 2	none	any	Details

Total release size: 61.4 kB

Release files / python-consul2-0.1.5.tar.gz

Download URL	python-consul2-0.1.5.tar.gz
Size	31.4 kB
Tags	Source
SHA-256 checksum How to use checksums	`29c859de73e17f36ab99be831fdc1d924f16e8772233277a28ef92b7b99995cd`
BLAKE2b-256 checksum How to use checksums	`a8a3bc0bdf7e0a68a1fa8e7a2302491e1931438a6d08ed21bd6830ba1595671b`
Upload date	Oct 20, 2020
Uploaded using Trusted Publishing? What is trusted publishing?	No
Uploaded via	`twine/3.2.0 pkginfo/1.5.0.1 requests/2.24.0 setuptools/49.2.1 requests-toolbelt/0.9.1 tqdm/4.50.2 CPython/3.9.0`

Release files / python_consul2-0.1.5-py2.py3-none-any.whl

Download URL	python_consul2-0.1.5-py2.py3-none-any.whl
Size	30.0 kB
Tags	Python 2 Python 3
SHA-256 checksum How to use checksums	`ff8c6642c5a8d5f13a072e90adbad44cde824fc46fb2ab76b40dd1c77d6c0c41`
BLAKE2b-256 checksum How to use checksums	`ff525230ba94ededbfafa9df95c19f1272cf03916b6d33fce341936e3c74dd86`
Upload date	Oct 20, 2020
Uploaded using Trusted Publishing? What is trusted publishing?	No
Uploaded via	`twine/3.2.0 pkginfo/1.5.0.1 requests/2.24.0 setuptools/49.2.1 requests-toolbelt/0.9.1 tqdm/4.50.2 CPython/3.9.0`