Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/poppyred/python-consul2

Python client for the Consul HTTP API ,Continue develop on cablehead/python-consul
https://github.com/poppyred/python-consul2

consul python-consul

Last synced: 3 months ago
JSON representation

Python client for the Consul HTTP API ,Continue develop on cablehead/python-consul

Host: GitHub
URL: https://github.com/poppyred/python-consul2
Owner: poppyred
License: mit
Archived: true
Created: 2019-09-12T03:33:17.000Z (about 5 years ago)
Default Branch: master
Last Pushed: 2022-02-16T14:20:41.000Z (over 2 years ago)
Last Synced: 2024-06-18T15:40:51.889Z (5 months ago)
Topics: consul, python-consul
Language: Python
Homepage: https://python-consul2.readthedocs.io/
Size: 26.1 MB
Stars: 131
Watchers: 8
Forks: 28
Open Issues: 22
Metadata Files:
- Readme: README.rst
- Changelog: CHANGELOG.rst
- License: LICENSE

Awesome Lists containing this project

awesome-repositories - poppyred/python-consul2 - Python client for the Consul HTTP API ,Continue develop on cablehead/python-consul (Python)

README

        Python client for `Consul.io `_

======================================================

|Build Status|

|Github-actions Build Status|

|License Status|

|Pypi Status|

|Pyversions Status|

|Docs Status|

|Coverage Status|

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

.. |Build Status|

   image:: https://api.travis-ci.org/poppyred/python-consul2.svg?branch=master

   :target: https://travis-ci.org/poppyred/python-consul2

.. |Github-actions Build Status|

   image:: https://github.com/poppyred/python-consul2/workflows/python-consul2-x86/badge.svg

   :target: https://github.com/poppyred/python-consul2/actions

.. |License Status|

   image:: https://img.shields.io/pypi/l/python-consul2

   :target: https://github.com/poppyred/python-consul2/blob/master/LICENSE

.. |Pypi Status|

   image:: https://img.shields.io/pypi/v/python-consul2

   :target: https://pypi.org/project/python-consul2/

.. |Pyversions Status|

   image:: https://img.shields.io/pypi/pyversions/python-consul2

   :target: https://pypi.org/project/python-consul2/

.. |Docs Status|

   image:: https://img.shields.io/readthedocs/python-consul2

   :target: https://python-consul2.readthedocs.io/

.. |Coverage Status1|

   image:: https://codecov.io/gh/poppyred/python-consul2/branch/master/graph/badge.svg

   :target: https://codecov.io/gh/poppyred/python-consul2

.. |Coverage Status|

   image:: https://codecov.io/gh/poppyred/python-consul2/branch/master/graph/badge.svg

   :target: https://codecov.io/gh/poppyred/python-consul2

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

------------

- [email protected]

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

~~~~~~~~

.. code:: bash

    # 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