chg: ✨ add user-agent header with SDK and Python versions (#36)

Author: ianardee

mindee/__init__.py

@@ -9,6 +9,7 @@
 from mindee.documents.invoice import Invoice
 from mindee.documents.passport import Passport
 
+
 DOCUMENT_CLASSES = {
     "receipt": Receipt,
     "invoice": Invoice,

mindee/http.py

@@ -1,4 +1,7 @@
 import requests
+from mindee.versions import __version__, python_version, get_platform
+
+platform = get_platform()
 
 
 def request(url, input_file, token, include_words=False):
@@ -12,7 +15,10 @@ def request(url, input_file, token, include_words=False):
     input_file.file_object.seek(0)
 
     files = {"document": (input_file.filename, input_file.file_object.read())}
-    headers = {"Authorization": f"Token {token}"}
+    headers = {
+        "Authorization": f"Token {token}",
+        "User-Agent": f"mindee-api-python@v{__version__} python-v{python_version} {platform}",
+    }
 
     params = {}
     if include_words:

mindee/versions.py

@@ -0,0 +1,19 @@
+import sys
+
+__version__ = "1.2.3"
+
+python_version = "%s.%s" % (sys.version_info[0], sys.version_info[1])
+
+
+def get_platform() -> str:
+    platforms = {
+        "linux": "linux",
+        "win32": "windows",
+        "darwin": "macos",
+        "aix": "aix",
+        "freebsd": "freebsd",
+    }
+    for name, agent_name in platforms.items():
+        if sys.platform.startswith(name):
+            return agent_name
+    return sys.platform

setup.py

@@ -1,7 +1,6 @@
 import re
 from setuptools import find_packages, setup
-
-__version__ = None
+from mindee.versions import __version__
 
 
 with open("README.md", "r", newline="", encoding="utf-8") as fh:
@@ -32,10 +31,10 @@ def make_requirements_list(file="requirements.txt", only_regular=True):
 
 
 setup(
-    python_requires=">=3.0",
+    python_requires=">=3.6",
     name=f"{PACKAGE_NAME}",
     description="Mindee API helper library for python",
-    version="v1.2.3",
+    version=__version__,
     long_description=long_description,
     long_description_content_type="text/markdown",
     url=GIT_URL,