Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: update README following fork detach and project move #68

Merged
merged 1 commit into from
Mar 29, 2024
Merged

docs: update README following fork detach and project move #68

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
39 changes: 27 additions & 12 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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
-------
Expand All @@ -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