README.rst
1Python client for `Consul.io <http://www.consul.io/>`_
2======================================================
3
4Documentation
5-------------
6
7`Read the Docs`_
8
9Status
10------
11
12|Build Status|
13
14Example
15-------
16
17.. code:: python
18
19 import consul
20
21 c = consul.Consul()
22
23 # poll a key for updates
24 index = None
25 while True:
26 index, data = c.kv.get('foo', index=index)
27 print data['Value']
28
29 # in another process
30 c.kv.put('foo', 'bar')
31
32Installation
33------------
34
35::
36
37 pip install python-consul
38
39**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.
40
41.. |Build Status|
42 image:: https://img.shields.io/travis/cablehead/python-consul.svg?style=flat-square
43 :target: https://travis-ci.org/cablehead/python-consul
44.. |Coverage Status|
45 image:: https://img.shields.io/coveralls/cablehead/python-consul.svg?style=flat-square
46 :target: https://coveralls.io/r/cablehead/python-consul?branch=master
47.. _Read the Docs: https://python-consul.readthedocs.io/
48
49Status
50------
51
52There's a few API endpoints still to go to expose all features available in
53Consul v0.6.0. If you need an endpoint that's not in the documentation, just
54open an issue and I'll try and add it straight away.
55
56Mailing List
57------------
58
59- https://groups.google.com/forum/#!forum/python-consul
60
61Contributing
62------------
63
64python-consul is currently maintained by:
65
66- @matusvalo
67- @abn
68- @cablehead
69
70Please reach out if you're interested in being a maintainer as well. Otherwise,
71open a PR or Issue we'll try and respond as quickly as we're able.
72
73Issue Labels
74~~~~~~~~~~~~
75
76:today!: Some triaging is in progress and this issue should be taken care of in
77 a couple of hours!
78
79:priority: There's a clear need to address this issue and it's likely a core
80 contributor will take it on. Opening a PR for these is greatly
81 appreciated!
82
83:help wanted: This issue makes sense and would be useful. It's unlikely a core
84 contributor will get to this though, so if you'd like to see it
85 addressed please open a PR.
86
87:question: The need for the issue isn't clear or needs clarification, so please
88 follow up. Issues in this state for a few months, without
89 responses will likely will be closed.
90
91PRs
92~~~
93
94Pull requests are very much appreciated! When you create a PR please ensure:
95
96#. All current tests pass, including flake8
97#. To add tests for your new features, if reasonable
98#. To add docstrings for new api features you add and if needed link to these
99 docstrings from the sphinx documentation
100
101Releases
102~~~~~~~~
103
104.. code:: bash
105
106 # release the current version, eg: 0.6.1-dev -> 0.6.1
107 bumpversion release
108
109 # prepare the next patch (z-stream) version, eg: 0.6.1 -> 0.6.2-dev
110 bumpversion --no-tag patch
111
112 # else, prepare the next minor (y-stream) version, eg: 0.6.1 -> 0.7.0-dev
113 bumpversion --no-tag minor
114
