Merge branch 'main' into SWAT-8089

Author: Dave Johnston

README.md

@@ -1,4 +1,4 @@
-Harness Feature Flag Python SDK
+Python SDK For Harness Feature Flags
 ========================
 
 [![pypi](https://img.shields.io/pypi/v/harness-featureflags.svg)](https://pypi.python.org/pypi/harness-featureflags)
@@ -13,10 +13,10 @@ Harness Feature Flag Python SDK
 
 ## Intro
 
-Harness Feature Flags (FF) is a feature management solution that enables users to change the software’s functionality, without deploying new code. FF uses feature flags to hide code or behaviours without having to ship new versions of the software. A feature flag is like a powerful if statement.
-* For more information, see https://harness.io/products/feature-flags/
-* To read more, see https://ngdocs.harness.io/category/vjolt35atg-feature-flags
-* To sign up, https://app.harness.io/auth/#/signup/
+Use this README to get started with our Feature Flags (FF) SDK for Python. This guide outlines the basics of getting started with the SDK and provides a full code sample for you to try out. 
+This sample doesn’t include configuration options, for in depth steps and configuring the SDK, for example, disabling streaming or using our Relay Proxy, see the  [Python SDK Reference](https://ngdocs.harness.io/article/hwoxb6x2oe-python-sdk-reference).
+
+For a sample FF Python SDK project, see our test [test Golang project](examples/getting_started/getting_started.py).
 
 ![FeatureFlags](https://github.com/harness/ff-python-server-sdk/raw/main/docs/images/ff-gui.png)
 
@@ -29,20 +29,22 @@ Harness Feature Flags (FF) is a feature management solution that enables users t
 
 
 ## Quickstart
-The Feature Flag SDK provides a client that connects to the feature flag service, and fetches the value
-of featue flags.   The following section provides an example of how to install the SDK and initalize it from
-an application.
-This quickstart assumes you have followed the instructions to [setup a Feature Flag project and have created a flag called `harnessappdemodarkmode` and created a server API Key](https://ngdocs.harness.io/article/1j7pdkqh7j-create-a-feature-flag#step_1_create_a_project).
+To follow along with our test code sample, make sure you’ve:
 
+- [Created a Feature Flag on the Harness Platform](https://ngdocs.harness.io/article/1j7pdkqh7j-create-a-feature-flag) called harnessappdemodarkmode
+- [Created a server SDK key and made a copy of it](https://ngdocs.harness.io/article/1j7pdkqh7j-create-a-feature-flag#step_3_create_an_sdk_key)
+- 
 ### Install the SDK
 Install the python SDK using pip
 ```python
 python -m pip install harness-featureflags
 ```
 
-### A Simple Example
-Here is a complete example that will connect to the feature flag service and report the flag value every 10 seconds until the connection is closed.  
-Any time a flag is toggled from the feature flag service you will receive the updated value.
+### Code Sample
+The following is a complete code example that you can use to test the `harnessappdemodarkmode` Flag you created on the Harness Platform. When you run the code it will:
+- Connect to the FF service.
+- Report the value of the Flag every 10 seconds until the connection is closed. Every time the harnessappdemodarkmode Flag is toggled on or off on the Harness Platform, the updated value is reported. 
+- Close the SDK.
 
 ```python
 from featureflags.client import CfClient
@@ -63,7 +65,7 @@ def main():
     client = CfClient(apiKey)
 
     # Create a target (different targets can get different results based on rules.  This include a custom attribute 'location')
-    target = Target(identifier='mytarget', name="FriendlyName", attributes={"location": "emea"}
+    target = Target(identifier='pythonSDK', name="PythonSDK", attributes={"location": "emea"})
 
     # Loop forever reporting the state of the flag
     while True:
@@ -85,9 +87,9 @@ $ export FF_API_KEY=<your key here>
 $ python3 examples/getting_started/getting_started.py
 ```
 
-### Running with docker
+### Running the example with Docker
 If you dont have the right version of python installed locally, or dont want to install the dependancies you can
-use docker to quicky get started
+use docker to quickly get started
 
 ```bash
 # Install the package
@@ -99,13 +101,13 @@ docker run  -e PYTHONPATH=/app/local -e FF_API_KEY=$FF_API_KEY -v $(pwd):/app -w
 
 ### Additional Reading
 
-Further examples and config options are in the further reading section:
-
-[Further Reading](docs/further_reading.md)
+For further examples and config options, see the [Python SDK Reference](https://ngdocs.harness.io/article/hwoxb6x2oe-python-sdk-reference).
 
+For more information about Feature Flags, see our [Feature Flags documentation](https://ngdocs.harness.io/article/0a2u2ppp8s-getting-started-with-feature-flags).
 
 -------------------------
 [Harness](https://www.harness.io/) is a feature management platform that helps teams to build better software and to
 test features quicker.
 
 -------------------------
+

docs/further_reading.md

@@ -2,6 +2,43 @@
 
 Covers advanced topics (different config options and scenarios)
 
+## Configuration Options
+The following configuration options are available to control the behaviour of the SDK.
+You can pass the configuration in as options when the SDK client is created.
+```python
+    # Create a Feature Flag Client
+    client = CfClient(apiKey,
+                      with_base_url("https://config.ff.harness.io/api/1.0"),
+                      with_events_url("https://events.ff.harness.io/api/1.0"),
+                      with_stream_enabled(True),
+                      with_analytics_enabled(True),
+                      Config(pull_interval=60))
+```
+
+| Name            | Config Option                                            | Description                                                                                                                                      | default                              |
+|-----------------|----------------------------------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------|--------------------------------------|
+| baseUrl         | with_base_url("https://config.ff.harness.io/api/1.0")    | the URL used to fetch feature flag evaluations. You should change this when using the Feature Flag proxy to http://localhost:7000                | https://config.ff.harness.io/api/1.0 |
+| eventsUrl       | with_events_url("https://events.ff.harness.io/api/1.0"), | the URL used to post metrics data to the feature flag service. You should change this when using the Feature Flag proxy to http://localhost:7000 | https://events.ff.harness.io/api/1.0 |
+| pollInterval    | Config(pull_interval=60)                                 | when running in stream mode, the interval in seconds that we poll for changes.                                                                   | 60                                   |
+| enableStream    | with_stream_enabled(True),                               | Enable streaming mode.                                                                                                                           | true                                 |
+| enableAnalytics | with_analytics_enabled(True)                             | Enable analytics.  Metrics data is posted every 60s                                                                                              | true                                 |
+| pollInterval    | with_poll_interval(120)                                  | When running in stream mode, the interval in seconds that we poll for changes.                                                                   | 60                                   |
+
+## Logging Configuration
+The SDK provides a logger that wraps the standard python logging package.  You can import and use it with:
+```python
+from featureflags.util import log
+log.info("Hello, World!")
+```
+
+If you want to change the default log level, you can use the standard logging levels
+```python
+from featureflags.util import log
+import logging
+
+log.setLevel(logging.WARN)
+```
+
 ## Recommended reading
 
 [Feature Flag Concepts](https://ngdocs.harness.io/article/7n9433hkc0-cf-feature-flag-overview)

examples/getting_started/getting_started.py

@@ -5,18 +5,21 @@
 import os
 import time
 
+
 # API Key
-apiKey = os.getenv('FF_API_KEY', "c9b3f14f-6336-4d23-83b4-73f29d1ebeeb")
+apiKey = os.getenv('FF_API_KEY', "")
 
 # Flag Name
 flagName = os.getenv('FF_FLAG_NAME', "harnessappdemodarkmode")
 
 def main():
+    log.info("Harness SDK Getting Started")
     # Create a Feature Flag Client
     client = CfClient(apiKey)
 
+
     # Create a target (different targets can get different results based on rules)
-    target = Target(identifier='mytarget', name="FriendlyName", attributes={"location": "emea"})
+    target = Target(identifier='pythonSDK', name="PythonSDK", attributes={"location": "emea"})
 
     # Loop forever reporting the state of the flag
     while True:

featureflags/client.py

@@ -23,7 +23,9 @@
 
 class CfClient(object):
     def __init__(
-        self, sdk_key: str, *options: Callable, config: Optional[Config] = None
+            self, sdk_key: str,
+            *options: Callable,
+            config: Optional[Config] = None
     ):
         self._client: Optional[Client] = None
         self._auth_token: Optional[str] = None
@@ -97,7 +99,7 @@ def authenticate(self):
         self._auth_token = response.auth_token
 
         decoded = decode(self._auth_token, options={
-                         "verify_signature": False})
+            "verify_signature": False})
         self._environment_id = decoded["environment"]
         self._cluster = decoded["clusterIdentifier"]
         if not self._cluster:
@@ -115,33 +117,38 @@ def authenticate(self):
     def bool_variation(self, identifier: str, target: Target,
                        default: bool) -> bool:
         variation = self._evaluator.evaluate(identifier, target)
-        self._analytics.enqueue(target, identifier, variation)
+        if self._config.enable_analytics:
+            self._analytics.enqueue(target, identifier, variation)
         return variation.bool(default)
 
     def int_variation(self, identifier: str, target: Target,
                       default: int) -> int:
         variation = self._evaluator.evaluate(identifier, target)
-        self._analytics.enqueue(target, identifier, variation)
+        if self._config.enable_analytics:
+            self._analytics.enqueue(target, identifier, variation)
         return variation.int(default)
 
     def number_variation(self, identifier: str, target: Target,
                          default: float) -> float:
         variation = self._evaluator.evaluate(
             identifier, target)
-        self._analytics.enqueue(target, identifier, variation)
+        if self._config.enable_analytics:
+            self._analytics.enqueue(target, identifier, variation)
         return variation.number(default)
 
     def string_variation(self, identifier: str, target: Target,
                          default: str) -> str:
         variation = self._evaluator.evaluate(
             identifier, target)
-        self._analytics.enqueue(target, identifier, variation)
+        if self._config.enable_analytics:
+            self._analytics.enqueue(target, identifier, variation)
         return variation.string(default)
 
     def json_variation(self, identifier: str, target: Target,
                        default: Dict[str, Any]) -> Dict[str, Any]:
         variation = self._evaluator.evaluate(identifier, target)
-        self._analytics.enqueue(target, identifier, variation)
+        if self._config.enable_analytics:
+            self._analytics.enqueue(target, identifier, variation)
         return variation.json(default)
 
     def close(self):

featureflags/config.py

@@ -16,16 +16,16 @@
 
 class Config(object):
     def __init__(
-        self,
-        base_url: str = BASE_URL,
-        events_url: str = EVENTS_URL,
-        pull_interval: int = PULL_INTERVAL,
-        persist_interval: int = PERSIST_INTERVAL,
-        events_sync_interval: int = EVENTS_SYNC_INTERVAL,
-        cache: Cache = None,
-        store: object = None,
-        enable_stream: bool = True,
-        enable_analytics: bool = True
+            self,
+            base_url: str = BASE_URL,
+            events_url: str = EVENTS_URL,
+            pull_interval: int = PULL_INTERVAL,
+            persist_interval: int = PERSIST_INTERVAL,
+            events_sync_interval: int = EVENTS_SYNC_INTERVAL,
+            cache: Cache = None,
+            store: object = None,
+            enable_stream: bool = True,
+            enable_analytics: bool = True
     ):
         self.base_url = base_url
         self.events_url = events_url
@@ -69,3 +69,10 @@ def func(config: Config) -> None:
         config.enable_analytics = value
 
     return func
+
+
+def with_pull_interval(value: int) -> Callable:
+    def func(config: Config) -> None:
+        config.pull_interval = value
+
+    return func

featureflags/polling.py

@@ -28,6 +28,12 @@ def __init__(self, client: AuthenticatedClient, config: Config,
 
     def run(self):
         if not self.__running:
+            if self.__config.pull_interval < 60:
+                log.warning("Pull Interval must be greater than or equal "
+                            "to 60 seconds, was: " +
+                            str(self.__config.pull_interval) +
+                            " setting to 60")
+                self.__config.pull_interval = 60
             log.info("Starting PollingProcessor with request interval: " +
                      str(self.__config.pull_interval))
             self.__running = True