Update documentation and clean up some old dependencies. (#244)

CHANGELOG.md

@@ -1,3 +1,10 @@
+## v5.6.0
+* (Major) Add support for event callbacks.
+
+## v5.5.0
+* (Minor) SDK now warns when multiple instances are created
+* (Bugfix) Fix an issue where the NOT_IN operator behaves incorrectly when inverted and no context is passed
+
 ## v5.4.1
 * (Bugfix) Fix an issue where custom stickiness fail to calculate correctly
 * (Bugfix) Fix floats not working correctly in constraints

UnleashClient/cache.py

@@ -12,7 +12,10 @@ class BaseCache(abc.ABC):
     """
     Abstract base class for caches used for UnleashClient.
 
-    If implementing your own bootstrapping methods, you must set the `bootstrapped` attribute to True after configuration is set.
+    If implementing your own bootstrapping methods:
+
+    - Add your custom bootstrap method.
+    - You must set the `bootstrapped` attribute to True after configuration is set.
     """
     bootstrapped = False
 

UnleashClient/events.py

@@ -5,12 +5,18 @@
 
 
 class UnleashEventType(Enum):
+    """
+    Indicates what kind of event was triggered.
+    """
     FEATURE_FLAG = "feature_flag"
     VARIANT = "variant"
 
 
 @dataclass
 class UnleashEvent:
+    """
+    Dataclass capturing information from an Unleash feature flag or variant check.
+    """
     event_type: UnleashEventType
     event_id: UUID
     context: dict

docs/conf.py

@@ -31,7 +31,8 @@
     "sphinx.ext.autosectionlabel",
     "sphinx.ext.autosummary",
     "sphinx.ext.githubpages",
-    "m2r2"
+    "m2r2",
+    "enum_tools.autoenum"
 ]
 
 # Add any paths that contain templates here, relative to this directory.

docs/customcache.rst

@@ -6,7 +6,7 @@ Implementing a custom cache
 #######################################
 
 - Create a custom cache object by sub-classing the BaseCache object.
-- Overwrite all the methods from the base class.
+- Overwrite all the methods from the base class.  You can also add custom bootstraping methods!
 
 .. code-block:: python
 

docs/eventcallbacks.rst

@@ -0,0 +1,35 @@
+****************************************
+Event Callbacks
+****************************************
+
+The Unleash Python client support event callbacks!  
+
+1. Create a function with the type `Callable[[UnleashEvent]]` and pass it to the Unleash client at initialization.
+2. Enable `impression data <https://docs.getunleash.io/reference/impression-data#enabling-impression-data>`_ on feature flag configuration.
+
+Example code using `blinker <https://github.com/pallets-eco/blinker>`_: 
+
+.. code-block:: python
+
+    from blinker import ignal
+    from UnleashClient import UnleashClient
+    from UnleashClient.events import UnleashEvent
+    
+    send_data = signal('send-data')
+
+    @send_data.connect
+    def receive_data(sender, **kw):
+        print("Caught signal from %r, data %r" % (sender, kw))
+        return kw
+
+    def example_callback(event: UnleashEvent):
+        send_data.send('anonymous', data=event)
+
+    # Set up Unleash
+    client = UnleashClient(
+        "https://unleash.herokuapp.com/api",
+        "My Program"
+        event_callback=example_callback
+    )
+    client.initialize_client()
+    client.is_enabled("testFlag")

docs/events.rst

@@ -2,4 +2,6 @@
 Events
 ****************************************
 
+.. autoenum :: UnleashClient.events.UnleashEventType
+
 .. autoclass:: UnleashClient.events.UnleashEvent

docs/index.rst

@@ -21,6 +21,7 @@ Documentation for Unleash's Python client.  See the sidebar for more topics!
 
     customstrategies
     customcache
+    eventcallbacks
     development
     wsgi
     celery

requirements.txt

@@ -8,12 +8,9 @@ python-dateutil
 semver
 
 # Development packages
-bumpversion
 coveralls
 mimesis
-mkdocs
 mypy
-pur
 pylint
 pytest
 pytest-cov
@@ -32,3 +29,4 @@ tox
 types-requests
 twine
 blinker
+enum-tools[sphinx]