feat: add user-agent header (#5)

Author: hezean

README.md

@@ -46,18 +46,18 @@ First, install the FeatureProbe SDK as a dependency in your application.
 #### pip
 
 ```bash
-pip3 install featureprobe-server
+pip3 install featureprobe-server-sdk-python
 ```
 
-> You may get the latest version of this repo (not released) via [TestPyPI](https://test.pypi.org/project/featureprobe-server/)
+> You may get the latest version of this repo (not released) via [TestPyPI](https://test.pypi.org/project/featureprobe-server-sdk-python/)
 
 <!-- WIP
 #### conda
 
 Will be supported later.
 
 ```bash
-conda install featureprobe-server
+conda install featureprobe-server-sdk-python
 ```
 -->
 

featureprobe/__init__.py

@@ -39,6 +39,8 @@
 
 
 __all__ = [
+    '__version__',
+
     # featureprobe.model
 
     'Condition',
@@ -58,6 +60,7 @@
     'Toggle',
 
     # featureprobe
+
     'AccessCounter',
     'AccessRecorder',
     'Client',

featureprobe/context.py

@@ -23,6 +23,7 @@ class Context:
     _POST_EVENTS_DATA_API = '/api/events'
 
     def __init__(self, sdk_key: str, config: "Config"):
+        from featureprobe import __version__
         self._synchronizer_url = config.synchronizer_url or (
             config.remote_uri + self._GET_REPOSITORY_DATA_API)
         self._event_url = config.event_url or (
@@ -31,6 +32,10 @@ def __init__(self, sdk_key: str, config: "Config"):
         self._refresh_interval = config.refresh_interval
         self._location = config.location
         self._http_config = config.http_config
+        self._headers = {
+            'Authorization': sdk_key,
+            'user-agent': 'Python/' + str(__version__),
+        }
 
     @property
     def synchronizer_url(self):
@@ -55,3 +60,7 @@ def location(self):
     @property
     def http_config(self):
         return self._http_config
+
+    @property
+    def headers(self):
+        return self._headers

featureprobe/default_event_processor.py

@@ -97,7 +97,7 @@ def __init__(self, context: Context):
         self._session = Session()
         self._session.mount('http://', context.http_config.adapter)
         self._session.mount('https://', context.http_config.adapter)
-        self._session.headers.update({'Authorization': context.sdk_key})
+        self._session.headers.update(context.headers)
         self._timeout = (
             context.http_config.conn_timeout,
             context.http_config.read_timeout)

featureprobe/pooling_synchronizer.py

@@ -32,8 +32,6 @@
 class PoolingSynchronizer(Synchronizer):
     __logger = logging.getLogger('FeatureProbe-Synchronizer')
 
-    _GET_SDK_KEY_HEADER = 'Authorization'
-
     def __init__(self, context: "Context", data_repo: "DataRepository"):
         self._refresh_interval = context.refresh_interval
         self._api_url = context.synchronizer_url
@@ -42,8 +40,7 @@ def __init__(self, context: "Context", data_repo: "DataRepository"):
         self._session = Session()
         self._session.mount('http://', context.http_config.adapter)
         self._session.mount('https://', context.http_config.adapter)
-        self._session.headers.update(
-            {PoolingSynchronizer._GET_SDK_KEY_HEADER: context.sdk_key})
+        self._session.headers.update(context.headers)
         self._timeout = (
             context.http_config.conn_timeout,
             context.http_config.read_timeout)

setup.py

@@ -42,7 +42,7 @@ def _requirements():
     pypi_classifiers.append('Development Status :: 5 - Production/Stable')
 
 setup(
-    name='featureprobe-server',
+    name='featureprobe-server-sdk-python',
     version=featureprobe.__version__,
 
     author='FeatureProbe',