Merge pull request #10 from aaronweeden/user-agent

Add `User-Agent` header identifying the package.

Author: aaronweeden

.github/workflows/python-package.yml

@@ -33,9 +33,9 @@ jobs:
     - name: Lint with flake8
       run: |
         # stop the build if there are linter errors (ignore complexity metrics)
-        flake8 . --count --max-line-length=127 --max-complexity=1000 --show-source --statistics
+        flake8 . --count --max-line-length=127 --max-complexity=1000 --show-source --statistics --exclude __init__.py
         # output complexity metrics
-        flake8 . --count --exit-zero --max-complexity=10 --max-line-length=127 --statistics
+        flake8 . --count --exit-zero --max-complexity=10 --max-line-length=127 --statistics --exclude __init__.py
     - name: Test with pytest
       run: |
         pytest tests/unit

setup.py

@@ -1,8 +1,10 @@
 from setuptools import setup, find_packages
+from xdmod.__version__ import __title__, __version__, __description__
+
 setup(
-    name="xdmod",
-    version="0.0.15",
-    description='Python driver for XDMoD',
+    name=__title__,
+    version=__version__,
+    description=__description__,
     license='LGPLv3',
     author='Joseph P White',
     author_email='jpwhite4@buffalo.edu',

xdmod/__init__.py

@@ -1 +1 @@
-""" Driver module for XDMoD """
+from .__version__ import __version__

xdmod/__version__.py

@@ -0,0 +1,3 @@
+__title__ = 'xdmod'
+__version__ = '1.0.0-alpha.1'
+__description__ = 'Python driver for XDMoD'

xdmod/_http_requester.py

@@ -3,6 +3,7 @@
 import requests
 from urllib.parse import urlencode
 import xdmod._validator as _validator
+from xdmod.__version__ import __title__, __version__
 
 
 class _HttpRequester:
@@ -16,7 +17,10 @@ def __init__(self, xdmod_host):
             raise KeyError(
                 '`XDMOD_API_TOKEN` environment variable has not been set.'
             ) from None
-        self.__headers = {'Authorization': 'Bearer ' + self.__api_token}
+        self.__headers = {
+            'Authorization': 'Bearer ' + self.__api_token,
+            'User-Agent': __title__ + ' Python v' + __version__,
+        }
         self.__requests_session = None
         self.__raw_data_limit = None