From ce9c7e20970e51abd1d567a9dbce79a40a316308 Mon Sep 17 00:00:00 2001 From: Mathias Brulatout Date: Fri, 29 Mar 2024 09:42:25 +0100 Subject: [PATCH] docs: update README following fork detach and project move --- README.md | 39 +++++++++++++++++++++++++++------------ 1 file changed, 27 insertions(+), 12 deletions(-) diff --git a/README.md b/README.md index 4178630..d5569cc 100644 --- a/README.md +++ b/README.md @@ -1,13 +1,15 @@ # py-consul [![PyPi version](https://img.shields.io/pypi/v/py-consul.svg)](https://pypi.python.org/pypi/py-consul/) [![Python version](https://img.shields.io/badge/python-3.8+-blue.svg)](https://www.python.org/downloads/) ![Status](https://img.shields.io/badge/status-maintained-green.svg) -Fork intent +Status ----------- +This project is maintained and actively developed by Criteo. +We aim at converging towards a full compatibility with the official Consul API. -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/ +We're currently supporting consul 1.13 up to 1.17. Due to quite a few changes +since our development started (see section "A bit of history"), some endpoints are +still partially handled. + +Therefore, we are open to contributions and suggestions. Example ------- @@ -33,17 +35,30 @@ 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. +**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. + +A bit of history +----------- + +The origin project [python-consul](https://github.com/cablehead/python-consul) is not maintained +since 2018. As we were 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 [PyPI](https://pypi.org/project/py-consul/) + +Following some major changes, we decided to detach this fork from the original project +and move from [criteo fork space](https://github.com/criteo-forks/) +to [criteo space](https://github.com/criteo/). 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. +open a PR or Issue we'll try and respond as quickly as possible. 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 +- To add tests for your new features, if applicable +- To add docstrings for new API features you may add