api_client: add a user-agent (#12)

flareio/api_client.py

@@ -11,6 +11,7 @@
 import typing as t
 
 from flareio.exceptions import TokenError
+from flareio.version import __version__ as _flareio_version
 
 
 class FlareApiClient:
@@ -34,6 +35,11 @@ def __init__(
     def _create_session() -> requests.Session:
         session = requests.Session()
 
+        # Set User-Agent
+        session.headers["User-Agent"] = (
+            f"python-flareio/{_flareio_version} requests/{requests.__version__}"
+        )
+
         # Don't accept cookies.
         session.cookies.set_policy(
             policy=DefaultCookiePolicy(

flareio/version.py

@@ -0,0 +1,19 @@
+import importlib.metadata
+
+import typing as t
+
+
+def _get_version() -> str:
+    package_name: str = __name__.split(".")[0]
+    try:
+        return importlib.metadata.version(package_name)
+    except importlib.metadata.PackageNotFoundError:
+        pass
+    return "unknown"
+
+
+__version__: t.Final[str] = _get_version()
+
+__all__ = [
+    "__version__",
+]

tests/test_api_client_endpoints.py

@@ -82,6 +82,22 @@ def test_get_path_only() -> None:
         assert mocker.last_request.url == "https://api.flare.io/hello/test"
 
 
+def test_get_user_agent() -> None:
+    client = get_test_client()
+    with requests_mock.Mocker() as mocker:
+        mocker.register_uri(
+            "GET",
+            "https://api.flare.io/hello/test",
+            status_code=200,
+        )
+        client.get("/hello/test")
+        assert mocker.last_request.url == "https://api.flare.io/hello/test"
+        user_agent = mocker.last_request.headers["User-Agent"]
+
+    assert "python-flareio/" in user_agent
+    assert "requests/" in user_agent
+
+
 def test_bad_domain() -> None:
     client = get_test_client()