Deprecated the consul dynamic settings reader

drgarcia1986 · Dec 29, 2021 · 4e032fb · 4e032fb
1 parent 44b5cc8
commit 4e032fb
Show file tree

Hide file tree

Showing 3 changed files with 15 additions and 2 deletions.
diff --git a/README.rst b/README.rst
@@ -438,8 +438,8 @@ In redis dynamic reader the binary types is automatically decoded.
     To install with redis dependencies use:
     ``pip install simple-settings[redis]``
 
-Consul
-^^^^^^
+Consul - Deprecated
+^^^^^^^^^^^^^^^^^^^
 
 You can read your settings dynamically from a consul server if you
 activate the ``DYNAMIC_SETTINGS`` special setting with the ``consul``
@@ -636,6 +636,12 @@ Any other config of dynamic settings will be pass to reader backend on argument
 
 Changelog
 ---------
+[NEXT_RELEASE]
+~~~~~~~~~~~~~~~~~~~~
+
+- Update dependencies
+- Deprecated Consul Dynamic Settings Reader
+
 
 [1.1.0] - 2021-10-26
 ~~~~~~~~~~~~~~~~~~~~

diff --git a/simple_settings/dynamic_settings/consul_reader.py b/simple_settings/dynamic_settings/consul_reader.py
@@ -1,3 +1,5 @@
+import warnings
+
 from .base import BaseReader
 
 try:
@@ -24,6 +26,10 @@ class Reader(BaseReader):
 
     def __init__(self, conf):
         super(Reader, self).__init__(conf)
+        warnings.warn(
+            'Consul Dynamic Settings Reader is deprecated',
+            DeprecationWarning
+        )
 
         self.session = consulate.Consul(
             host=self.conf['host'],

diff --git a/tests/dynamic_settings/test_consul.py b/tests/dynamic_settings/test_consul.py
@@ -13,6 +13,7 @@
     skip = True
 
 
+@pytest.mark.xfail
 @pytest.mark.skipif(skip, reason='Installed without consul')
 class TestDynamicConsulSettings: