feature: list, get, and download methods

Author: samedii

.gitignore

@@ -0,0 +1,5 @@
+*.pyc
+.venv
+venv
+.vscode
+.env.development.secrets

.python-version

@@ -0,0 +1 @@
+3.9.13

README.md

@@ -0,0 +1,63 @@
+# deepinspection python
+
+Python client library for deepinspection. Designed to simplify and exemplify interaction with the External API.
+
+## Usage
+
+```python
+import deepinspection
+
+
+client = deepinspection.track.client(
+    deepinspection_customer="customer-identifier",
+    deepinspection_client_id="XYZ",
+    deepinspection_client_secret="XYZ",
+)
+
+# list exports
+exports = client.exports.fastenings.list()
+
+# get export data
+for line in client.exports.fastenings.get_data(exports[0]["id"]):
+    pass
+```
+
+_The customer identifier should match with the website url `https://customer-identifier.track.deepinspection.io/`._
+
+exports
+
+```json
+[
+  {
+    "updated": "2024-02-01T23:20:20.605136+00:00",
+    "id": "461731a1-96c8-4ed6-99e4-9fe424eb9c40",
+    "measurement_name": "20231001_124327_2011T",
+    "type": "fastenings",
+    "downloaded": null,
+    "created": "2024-02-01T23:20:20.605136+00:00",
+    "user_id": "a338595f-6eba-481b-9f0f-112290a1078b"
+  },
+...
+```
+
+export_data
+
+```json
+{"export_datetime": "2024-02-04T21:21:12.866787", "measurement": "20231001_124327_2011T"}
+{"id": "56fb582a-0280-43fa-81f3-2a444e7e4273", "position_geographical": {"track_section": "111",
+...
+```
+
+## Installation
+
+Use your preferred package manager:
+
+```bash
+poetry add deepinspection
+```
+
+or
+
+```bash
+pip install deepinspection
+```

deepinspection/__init__.py

@@ -0,0 +1 @@
+from . import track

deepinspection/track/__init__.py

@@ -0,0 +1 @@
+from .client import DeepInspectionTrackClient as client

deepinspection/track/client.py

@@ -0,0 +1,83 @@
+from __future__ import annotations
+
+import json
+from typing import Generator, List
+
+import requests
+from pydantic import BaseModel
+
+
+class Fastenings(BaseModel):
+    client: DeepInspectionTrackClient
+
+    def list(self) -> List[dict]:
+        url = f"{self.client.base_url()}/exports/fastenings"
+        response = requests.get(url, headers=self.client.auth_headers())
+        response.raise_for_status()
+        return response.json()
+
+    def get(self, export_id) -> dict:
+        url = f"{self.client.base_url()}/exports/fastenings/{export_id}"
+        response = requests.get(url, headers=self.client.auth_headers())
+        response.raise_for_status()
+        return response.json()
+
+    def get_data(self, export_id) -> Generator[dict, None, None]:
+        url = f"{self.client.base_url()}/exports/fastenings/{export_id}/data"
+        response = requests.get(url, headers=self.client.auth_headers(), stream=True)
+        response.raise_for_status()
+
+        for line in response.iter_lines():
+            if line:
+                yield json.loads(line.decode("utf-8"))
+
+
+class Exports(BaseModel):
+    client: DeepInspectionTrackClient
+
+    @property
+    def fastenings(self):
+        return Fastenings(client=self.client)
+
+
+class DeepInspectionTrackClient(BaseModel):
+    customer_identifier: str
+    client_id: str
+    client_secret: str
+
+    def base_url(self):
+        return f"https://{self.customer_identifier}.api.track.deepinspection.io/external/v0-alpha"
+
+    def auth_headers(self):
+        return {
+            "Authorization": f"Bearer {self.access_token()}",
+            "X-Customer-ID": self.customer_identifier,
+        }
+
+    def openid_connect_url(self):
+        return f"https://auth.nextml.com/auth/realms/deepinspection-track-{self.customer_identifier}/.well-known/openid-configuration"
+
+    def access_token(self) -> str:
+        response = requests.get(self.openid_connect_url())
+        if response.status_code != 200:
+            raise Exception("Failed to authenticate with OIDC")
+
+        oidc_discoveries = response.json()
+        token_url = oidc_discoveries["token_endpoint"]
+
+        response = requests.post(
+            token_url,
+            data=dict(grant_type="client_credentials"),
+            auth=(self.client_id, self.client_secret),
+        )
+
+        if response.status_code != 200:
+            raise Exception(
+                f"Failed to authenticate, status code {response.status_code}, text {response.text}"
+            )
+
+        return response.json()["access_token"]
+
+    @property
+    def exports(self):
+        return Exports(client=self)

poetry.lock

@@ -0,0 +1,23 @@
+[tool.poetry]
+name = "deepinspection-python"
+version = "0.1.0"
+description = ""
+authors = ["NextML"]
+readme = "README.md"
+
+[tool.poetry.dependencies]
+python = "^3.9,<3.11"
+requests = "^2.31.0"
+pydantic = "^2.6.0"
+
+
+[tool.poetry.group.dev.dependencies]
+black = "^24.1.1"
+pytest = "^8.0.0"
+ipykernel = "^6.29.0"
+ipywidgets = "^8.1.1"
+pydantic-settings = "^2.1.0"
+
+[build-system]
+requires = ["poetry-core"]
+build-backend = "poetry.core.masonry.api"

pyproject.toml

@@ -0,0 +1,4 @@
+[pytest]
+python_files = *.py
+norecursedirs = venv .venv __pycache__ .git .pytest_cache
+testpaths = deepinspection tests