Saimon/add user agent header (#317)

* add version module, remove redundant version and platform modules, add user agent to include platform, python ver, aiohttp ver, and cterasdk ver
* update changelog
* resolve flake8 errors

Author: saimonation

cterasdk/__init__.py

@@ -1,6 +1,7 @@
 # pylint: disable=wrong-import-position
 import cterasdk.settings  # noqa: E402, F401
 import cterasdk.exceptions  # noqa: E402, F401
+from .version import __version__  # noqa: E402, F401
 
 from .common import Object, PolicyRule  # noqa: E402, F401
 from .convert import fromjsonstr, tojsonstr, fromxmlstr, toxmlstr  # noqa: E402, F401

cterasdk/clients/base.py

@@ -1,8 +1,11 @@
 import logging
+import platform
 import threading
+import aiohttp
 from . import async_requests, errors
 from .settings import ClientSessionSettings, TraceSettings
 from ..common import utils
+from ..version import __version__
 
 
 logger = logging.getLogger('cterasdk.http')
@@ -27,7 +30,13 @@ class PersistentHeaders:
     """Headers to include in every request"""
 
     def __init__(self):
-        self._headers = {}
+        self._headers = {
+            'User-Agent': (
+                f"CTERA Python SDK/{__version__}; aiohttp/{aiohttp.__version__};"
+                f" ({' '.join([platform.system(), str(platform.release())])}; {platform.machine()};"
+                f" Python {'.'.join(platform.python_version_tuple())});"
+            )
+        }
 
     @property
     def all(self):

cterasdk/lib/__init__.py

@@ -1,7 +1,6 @@
 from .cmd import Command  # noqa: E402, F401
 from .consent import ask  # noqa: E402, F401
 from .tempfile import TempfileServices  # noqa: E402, F401
-from .version import Version  # noqa: E402, F401
 from .iterator import QueryIterator, BaseResponse, \
     DefaultResponse, KeyValueQueryIterator, QueryLogsResponse, CursorResponse  # noqa: E402, F401
 from .tracker import track, ErrorStatus  # noqa: E402, F401

cterasdk/lib/platform.py

@@ -0,0 +1 @@
+__version__ = '2.20.20'

cterasdk/lib/version.py

@@ -1,6 +1,15 @@
 Changelog
 =========
 
+2.20.20
+-------
+
+Improvements
+^^^^^^^^^^^^
+
+* Add unique User-Agent header to all requests made by the CTERA Python SDK
+
+
 2.20.19
 -------