Add version info to user agent + log versions in log file

Partially fixes MerginMaps/qgis-plugin#150

The log should now contain lines like this:

--- version: Python-client/0.5.2 Plugin/2020.5.0 QGIS/3.15.0-Master (Linux/Ubuntu)

Author: wonder-sk

mergin/__init__.py

@@ -3,3 +3,4 @@
 from .client import MerginClient
 from .common import ClientError, LoginError
 from .merginproject import MerginProject, InvalidProject
+from .version import __version__

mergin/client.py

@@ -16,6 +16,7 @@
 from .client_pull import pull_project_async, pull_project_wait, pull_project_finalize
 from .client_push import push_project_async, push_project_wait, push_project_finalize
 from .utils import DateTimeEncoder
+from .version import __version__
 
 
 this_dir = os.path.dirname(os.path.realpath(__file__))
@@ -43,7 +44,9 @@ def __init__(self, url=None, auth_token=None, login=None, password=None, plugin_
         self._auth_params = None
         self._auth_session = None
         self._user_info = None
-        self.client_version = plugin_version if plugin_version is not None else "Python-client/--"
+        self.client_version = "Python-client/" + __version__
+        if plugin_version is not None:   # this could be e.g. "Plugin/2020.1 QGIS/3.14"
+            self.client_version += " " + plugin_version
         if auth_token:
             token_data = decode_token_data(auth_token)
             self._auth_session = {
@@ -89,6 +92,21 @@ def default_url():
         """ Returns URL of the public instance of Mergin """
         return 'https://public.cloudmergin.com'
 
+    def user_agent_info(self):
+        """ Returns string as it is sent as User-Agent http header to the server """
+        system_version = "Unknown"
+        if platform.system() == "Linux":
+            try:
+                from pip._vendor import distro
+                system_version = distro.linux_distribution()[0]
+            except ModuleNotFoundError:  # pip may not be installed...
+                system_version = "Linux"
+        elif platform.system() == "Windows":
+            system_version = platform.win32_ver()[0]
+        elif platform.system() == "Mac":
+            system_version = platform.mac_ver()[0]
+        return f"{self.client_version} ({platform.system()}/{system_version})"
+
     def _check_token(f):
         def wrapper(self, *args):
             if (not self._auth_session or self._auth_session['expire'] < datetime.now(timezone.utc)) and self._auth_params:
@@ -108,18 +126,7 @@ def _do_request(self, request):
 
             if self._auth_session:
                 request.add_header("Authorization", self._auth_session["token"])
-                system_version = "Unknown"
-                if platform.system() == "Linux":
-                    try:
-                        from pip._vendor import distro
-                        system_version = distro.linux_distribution()[0]
-                    except ModuleNotFoundError:   # pip may not be installed...
-                        system_version = "Linux"
-                elif platform.system() == "Windows":
-                    system_version =  platform.win32_ver()[0]
-                elif platform.system() == "Mac":
-                    system_version = platform.mac_ver()[0]
-                request.add_header("User-Agent", f"{self.client_version} ({platform.system()}/{system_version})")
+        request.add_header("User-Agent", self.user_agent_info())
         try:
             return self.opener.open(request)
         except urllib.error.HTTPError as e:
@@ -212,6 +219,7 @@ def login(self, login, password):
             url = urllib.parse.urljoin(self.url, urllib.parse.quote("/v1/auth/login"))
             data = json.dumps(self._auth_params, cls=DateTimeEncoder).encode("utf-8")
             request = urllib.request.Request(url, data, {"Content-Type": "application/json"}, method="POST")
+            request.add_header("User-Agent", self.user_agent_info())
             resp = self.opener.open(request)
             data = json.load(resp)
             session = data["session"]

mergin/client_pull.py

@@ -110,6 +110,7 @@ def download_project_async(mc, project_path, directory):
     os.makedirs(directory)
     mp = MerginProject(directory)
 
+    mp.log.info("--- version: " + mc.user_agent_info())
     mp.log.info(f"--- start download {project_path}")
 
     try:
@@ -320,6 +321,7 @@ def pull_project_async(mc, directory):
     project_path = mp.metadata["name"]
     local_version = mp.metadata["version"]
 
+    mp.log.info("--- version: " + mc.user_agent_info())
     mp.log.info(f"--- start pull {project_path}")
 
     server_info = mc.project_info(project_path, since=local_version)

mergin/client_push.py

@@ -81,6 +81,7 @@ def push_project_async(mc, directory):
     project_path = mp.metadata["name"]
     local_version = mp.metadata["version"]
 
+    mp.log.info("--- version: " + mc.user_agent_info())
     mp.log.info(f"--- start push {project_path}")
 
     server_info = mc.project_info(project_path)

mergin/version.py

@@ -0,0 +1,6 @@
+
+# The version is also stored in ../setup.py
+__version__ = '0.5.2'
+
+# There seems to be no single nice way to keep version info just in one place:
+# https://packaging.python.org/guides/single-sourcing-package-version/

setup.py

@@ -5,7 +5,7 @@
 
 setup(
     name='mergin-client',
-    version='0.5.2',
+    version='0.5.2',       # The version is also stored in mergin/version.py
     url='https://github.com/lutraconsulting/mergin-py-client',
     license='MIT',
     author='Lutra Consulting Ltd.',