Python client for `Consul.io <http://www.consul.io/>`_
======================================================
Fork intent
-----------
The origin project https://github.com/cablehead/python-consul is not maintained
since 2018. As we're not able to get in touch with the maintainer (cablehead)
to merge and release our PRs, we've forked the project in order to continue the
maintenance of the project. We also renamed the project to be able to upload
on pypi; see https://pypi.org/project/py-consul/
Example
-------
.. code:: python
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 py-consul
**Note:** When using py-consul library in environment with proxy server, setting of ``http_proxy``, ``https_proxy`` and ``no_proxy`` environment variables can be required for proper functionality.
Contributing
------------
py-consul is currently maintained by Criteo folks.
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.
When you create a PR please ensure:
#. To add tests for your new features, if reasonable
#. To add docstrings for new api features you may add
Change log
==========
1.3.0
-----
* feature: drop tornado and twisted support
* env: support python 3.10 and 3.11
* env: drop support of EOL python versions 3.5, 3.6 and 3.7
* code-style: syntax modernization
* code-style: formatter and linter use
* ci: multiple python version test and linter enforcement
1.2.4
-----
* feature: aio: allow setting timeout by request
1.2.3
-----
* feature: base: ensure return format of json callback is more consistent
1.2.2
-----
* bugfix: connect: fix wrong endpoints callbacks
1.2.1
-----
* feature: Add support for context-managers
* feature: Add support for /agent/service/:service_id API
* bugfix: rename internal connect method
1.2.0
-----
* feature: Support deregister field in Check.script
* feature: Introduce Consul Connect-related API wrappers
* feature: Add token support missing in multiple methods
* bugfix: aio: fix timeout type
* feature: allow multiple tags in service health query
1.1.5
-----
* Dummy release to overcome a pypi release issue
1.1.4
-----
* bugfix: fixed connection_timeout usage for aiohttp
1.1.3
-----
* bugfix: fixed connection_limit usage for aiohttp
1.1.2
-----
* add support for connection_limit and connection_timeout in aiohttp
* fix asyncio session close
1.1.1
-----
* Add support for python 3.7 and 3.8
* Fix asyncio compatibility to support latest python version
* Remove six dependency
* Use new style of class declaration
* Get rid of py3.4 old compat
* Drop support of deprecated python2
* base: allow weights parameter in service register
Base fork
---------
Criteo starts forking this library from https://github.com/cablehead/python-consul
Raw data
{
"_id": null,
"home_page": "https://github.com/criteo-forks/py-consul",
"name": "py-consul",
"maintainer": "",
"docs_url": null,
"requires_python": "",
"maintainer_email": "",
"keywords": "",
"author": "Criteo",
"author_email": "github@criteo.com",
"download_url": "https://files.pythonhosted.org/packages/b5/ab/8df8aa87158b835c25dcfd51a7d57fb8ee365ec2a47120a3e830923a8b21/py-consul-1.3.0.tar.gz",
"platform": null,
"description": "Python client for `Consul.io <http://www.consul.io/>`_\n======================================================\n\nFork intent\n-----------\n\nThe origin project https://github.com/cablehead/python-consul is not maintained\nsince 2018. As we're not able to get in touch with the maintainer (cablehead)\nto merge and release our PRs, we've forked the project in order to continue the\nmaintenance of the project. We also renamed the project to be able to upload\non pypi; see https://pypi.org/project/py-consul/\n\nExample\n-------\n\n.. code:: python\n\n import consul\n\n c = consul.Consul()\n\n # poll a key for updates\n index = None\n while True:\n index, data = c.kv.get('foo', index=index)\n print data['Value']\n\n # in another process\n c.kv.put('foo', 'bar')\n\nInstallation\n------------\n\n::\n\n pip install py-consul\n\n**Note:** When using py-consul library in environment with proxy server, setting of ``http_proxy``, ``https_proxy`` and ``no_proxy`` environment variables can be required for proper functionality.\n\nContributing\n------------\n\npy-consul is currently maintained by Criteo folks.\n\nPlease reach out if you're interested in being a maintainer as well. Otherwise,\nopen a PR or Issue we'll try and respond as quickly as we're able.\n\nWhen you create a PR please ensure:\n\n#. To add tests for your new features, if reasonable\n#. To add docstrings for new api features you may add\n\n\nChange log\n==========\n1.3.0\n-----\n* feature: drop tornado and twisted support\n* env: support python 3.10 and 3.11\n* env: drop support of EOL python versions 3.5, 3.6 and 3.7\n* code-style: syntax modernization\n* code-style: formatter and linter use\n* ci: multiple python version test and linter enforcement\n\n1.2.4\n-----\n* feature: aio: allow setting timeout by request\n\n1.2.3\n-----\n* feature: base: ensure return format of json callback is more consistent\n\n1.2.2\n-----\n* bugfix: connect: fix wrong endpoints callbacks\n\n1.2.1\n-----\n* feature: Add support for context-managers\n* feature: Add support for /agent/service/:service_id API\n* bugfix: rename internal connect method\n\n1.2.0\n-----\n* feature: Support deregister field in Check.script\n* feature: Introduce Consul Connect-related API wrappers\n* feature: Add token support missing in multiple methods\n* bugfix: aio: fix timeout type\n* feature: allow multiple tags in service health query\n\n1.1.5\n-----\n* Dummy release to overcome a pypi release issue\n\n1.1.4\n-----\n* bugfix: fixed connection_timeout usage for aiohttp\n\n1.1.3\n-----\n* bugfix: fixed connection_limit usage for aiohttp\n\n1.1.2\n-----\n* add support for connection_limit and connection_timeout in aiohttp\n* fix asyncio session close\n\n1.1.1\n-----\n\n* Add support for python 3.7 and 3.8\n* Fix asyncio compatibility to support latest python version\n* Remove six dependency\n* Use new style of class declaration\n* Get rid of py3.4 old compat\n* Drop support of deprecated python2\n* base: allow weights parameter in service register\n\nBase fork\n---------\nCriteo starts forking this library from https://github.com/cablehead/python-consul\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "Python client for Consul (http://www.consul.io/)",
"version": "1.3.0",
"project_urls": {
"Homepage": "https://github.com/criteo-forks/py-consul"
},
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "fbee884cf30efc9ec086955101a09c516b00d73ae697a50b527521594419ef7b",
"md5": "4ca262ac0dd33a1af25150399ee6bf47",
"sha256": "84114266d4a0fbea8d0fcec0bba8c3458fb4dfee2345437e106b85e5af9fabe9"
},
"downloads": -1,
"filename": "py_consul-1.3.0-py2.py3-none-any.whl",
"has_sig": false,
"md5_digest": "4ca262ac0dd33a1af25150399ee6bf47",
"packagetype": "bdist_wheel",
"python_version": "py2.py3",
"requires_python": null,
"size": 21213,
"upload_time": "2023-12-08T09:07:29",
"upload_time_iso_8601": "2023-12-08T09:07:29.130905Z",
"url": "https://files.pythonhosted.org/packages/fb/ee/884cf30efc9ec086955101a09c516b00d73ae697a50b527521594419ef7b/py_consul-1.3.0-py2.py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "b5ab8df8aa87158b835c25dcfd51a7d57fb8ee365ec2a47120a3e830923a8b21",
"md5": "3b6ecce1cb397dbe993cff12456d2121",
"sha256": "fa6b2850475c860bd9cee07d1ce62ba9909a12002eec903afe66103eb0743e68"
},
"downloads": -1,
"filename": "py-consul-1.3.0.tar.gz",
"has_sig": false,
"md5_digest": "3b6ecce1cb397dbe993cff12456d2121",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 30995,
"upload_time": "2023-12-08T09:07:30",
"upload_time_iso_8601": "2023-12-08T09:07:30.872994Z",
"url": "https://files.pythonhosted.org/packages/b5/ab/8df8aa87158b835c25dcfd51a7d57fb8ee365ec2a47120a3e830923a8b21/py-consul-1.3.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-12-08 09:07:30",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "criteo-forks",
"github_project": "py-consul",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"requirements": [],
"tox": true,
"lcname": "py-consul"
}
JSON
