Add a version variable in a standard way, update publishing script to account for the change, add new methods in Eva object

Author: LouisBrunner

.github/workflows/publish.yml

@@ -24,7 +24,7 @@ jobs:
       # Transform refs/tags/v0.0.2a01 to 0.0.2a01 and inject it into setup.py
       run: |
         export VERSION=`echo $VERSION_RAW | sed -E 's;.*/v(.*)$;\1;'`
-        sed -i 's/%VERSION%/'$VERSION'/' setup.py
+        sed -i 's/%VERSION%/'$VERSION'/' evasdk/version.py
         python setup.py sdist bdist_wheel
     - name: Publish a Python distribution to PyPI
       uses: pypa/gh-action-pypi-publish@master

Pipfile

@@ -9,11 +9,12 @@ websockets = "*"
 
 [dev-packages]
 flake8 = "*"
+requests-mock = "*"
 pytest = "*"
 "pytest-cov" = "*"
 
 [requires]
 
 [scripts]
 test = "python -m pytest tests/"
-lint = "flake8"
+lint = "flake8"

Pipfile.lock

@@ -39,9 +39,19 @@ def __exit__(self, type, value, traceback):
 
 
     # --------------------------------------------- HTTP HANDLERS ---------------------------------------------
-    def api_call_with_auth(self, method, path, payload=None):
+    def api_call_with_auth(self, method, path, payload=None, headers={}, timeout=None, version='v1'):
         self.__logger.debug('Eva.api_call_with_auth {} {}'.format(method, path))
-        return self.__http_client.api_call_with_auth(method, path, payload=payload)
+        return self.__http_client.api_call_with_auth(method, path, payload=payload, headers=headers, timeout=timeout, version=version)
+
+    def api_call_no_auth(self, method, path, payload=None, headers={}, timeout=None, version='v1'):
+        self.__logger.debug('Eva.api_call_no_auth {} {}'.format(method, path))
+        return self.__http_client.api_call_no_auth(method, path, payload=payload, headers=headers, timeout=timeout, version=version)
+
+
+    # Global
+    def versions(self):
+        self.__logger.debug('Eva.versions called')
+        return self.__http_client.api_versions()
 
 
     # Auth

evasdk/Eva.py

@@ -76,3 +76,4 @@
     EvaError,
     EvaValidationError, EvaAuthError, EvaAutoRenewError,
     EvaAdminError, EvaServerError)
+from .version import __version__

evasdk/__init__.py

@@ -5,6 +5,7 @@
 
 from .robot_state import RobotState
 from .eva_errors import eva_error, EvaError, EvaAutoRenewError
+from .version import __version__
 
 # TODO add more granular logs using __logger
 # TODO lots of sleeps in control_* de to the robot state being updated slowly after starting an action, can this be improved?
@@ -66,6 +67,7 @@ def __api_request(self, method, path, payload=None, headers={}, timeout=None, ve
 
         if add_auth:
             headers['Authorization'] = f'Bearer {self.session_token}'
+        headers['User-Agent'] = f'Automata EvaSDK/{__version__} (Python)'
 
         api_path = path
         if version is not None:

evasdk/eva_http_client.py

@@ -0,0 +1,5 @@
+# This is replaced by .github/workflows/publish.yml when creating a release
+version = '%VERSION%'
+
+# Use the above version if it has been replaced, otherwise use a dev placeholder
+__version__ = version if version.count('%') == 0 else '0.0.dev0'

evasdk/version.py

@@ -1,11 +1,12 @@
 import setuptools
+from evasdk.version import __version__
 
 with open("README.md", "r") as fh:
     long_description = fh.read()
 
 setuptools.setup(
     name='evasdk',
-    version='%VERSION%',
+    version=__version__,
     description='SDK for the Automata Eva robotic arm',
     author='Automata',
     license='Apache License 2.0',

setup.py

@@ -0,0 +1,16 @@
+from evasdk import Eva
+
+
+class TestEva_API:
+    def test_user_agent(self, requests_mock):
+        eva = Eva("example.com", "NONE")
+
+        requests_mock.register_uri(
+            'GET', 'http://example.com/api/versions',
+            request_headers={
+                'User-Agent': 'Automata EvaSDK/0.0.dev0 (Python)',
+            },
+            json={'APIs': ['v1']},
+        )
+        versions = eva.versions()
+        assert(versions['APIs'][0] == 'v1')