eyesoft-api-client 0.1.0__tar.gz

eyesoft_api_client-0.1.0/PKG-INFO

@@ -0,0 +1,125 @@
+Metadata-Version: 2.4
+Name: eyesoft-api-client
+Version: 0.1.0
+Summary: 
+Author: Arnaud-Marie Gallardo
+Author-email: arnaud.g@eyesoft.fr
+Requires-Python: >=3.13
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Programming Language :: Python :: 3.14
+Requires-Dist: httpx (>=0.28.1,<0.29.0)
+Description-Content-Type: text/markdown
+
+# Eyesoft API Client
+
+Python client for the Eyesoft API.
+
+## Installation
+
+```bash
+pip install eyesoft-api-client
+```
+
+## Quick start
+
+```python
+from eyesoft_api_client import Client
+
+with Client(
+    base_url="https://api.example.com",
+    username="user",
+    password="pass",
+    client_id="client_id",
+    client_secret="client_secret",
+) as client:
+    patients = client.list_patients()
+    print(patients[0].id)
+```
+
+## Authentication
+
+The client authenticates with the API using OAuth2 (username/password + client credentials). Tokens are managed automatically by the HTTP session.
+
+| Parameter | Description |
+|---|---|
+| `base_url` | Root URL of the API (no trailing slash) |
+| `username` | User account login |
+| `password` | User account password |
+| `client_id` | OAuth2 client ID |
+| `client_secret` | OAuth2 client secret |
+
+## Usage
+
+### Patients
+
+```python
+# List all patients
+patients = client.list_patients()
+
+# Fetch a single patient by UUID
+patient = client.get_patient("550e8400-e29b-41d4-a716-446655440000")
+
+# Access patient fields directly as attributes
+print(patient.id, patient.name)
+```
+
+### Exercises
+
+```python
+# List all exercises for a patient
+exercises = patient.list_exercises()
+
+# Fetch a single exercise for a patient
+exercise = patient.get_exercise("550e8400-e29b-41d4-a716-446655440001")
+
+# Fetch raw exercise data (parsed JSON)
+data = exercise.get_data()
+
+# Or fetch exercise data directly from the client
+data = client.get_exercise_data("550e8400-e29b-41d4-a716-446655440001")
+```
+
+### Resource objects
+
+`Patient` and `Exercise` objects proxy attribute access to the underlying API response, so any field returned by the API is accessible directly:
+
+```python
+patient = client.get_patient("550e8400-e29b-41d4-a716-446655440000")
+patient.id        # any field in the JSON response
+patient["name"]   # dict-style access also works
+```
+
+### Lifecycle
+
+Use the client as a context manager (recommended) to ensure the underlying HTTP session is closed:
+
+```python
+with Client(...) as client:
+    ...
+```
+
+Or manage it manually:
+
+```python
+client = Client(...)
+try:
+    ...
+finally:
+    client.close()
+```
+
+## Development
+
+### Publishing
+
+This project uses [python-semantic-release](https://python-semantic-release.readthedocs.io/) with [Conventional Commits](https://www.conventionalcommits.org/) for automated versioning and publishing to PyPI via GitLab CI.
+
+Releases are triggered automatically on every push to the default branch when the commit history contains releasable changes:
+
+| Commit prefix | Version bump |
+|---|---|
+| `fix: ...` | Patch (0.1.0 → 0.1.1) |
+| `feat: ...` | Minor (0.1.0 → 0.2.0) |
+| `feat!: ...` / `BREAKING CHANGE:` | Major (0.1.0 → 1.0.0) |
+

eyesoft_api_client-0.1.0/README.md

@@ -0,0 +1,111 @@
+# Eyesoft API Client
+
+Python client for the Eyesoft API.
+
+## Installation
+
+```bash
+pip install eyesoft-api-client
+```
+
+## Quick start
+
+```python
+from eyesoft_api_client import Client
+
+with Client(
+    base_url="https://api.example.com",
+    username="user",
+    password="pass",
+    client_id="client_id",
+    client_secret="client_secret",
+) as client:
+    patients = client.list_patients()
+    print(patients[0].id)
+```
+
+## Authentication
+
+The client authenticates with the API using OAuth2 (username/password + client credentials). Tokens are managed automatically by the HTTP session.
+
+| Parameter | Description |
+|---|---|
+| `base_url` | Root URL of the API (no trailing slash) |
+| `username` | User account login |
+| `password` | User account password |
+| `client_id` | OAuth2 client ID |
+| `client_secret` | OAuth2 client secret |
+
+## Usage
+
+### Patients
+
+```python
+# List all patients
+patients = client.list_patients()
+
+# Fetch a single patient by UUID
+patient = client.get_patient("550e8400-e29b-41d4-a716-446655440000")
+
+# Access patient fields directly as attributes
+print(patient.id, patient.name)
+```
+
+### Exercises
+
+```python
+# List all exercises for a patient
+exercises = patient.list_exercises()
+
+# Fetch a single exercise for a patient
+exercise = patient.get_exercise("550e8400-e29b-41d4-a716-446655440001")
+
+# Fetch raw exercise data (parsed JSON)
+data = exercise.get_data()
+
+# Or fetch exercise data directly from the client
+data = client.get_exercise_data("550e8400-e29b-41d4-a716-446655440001")
+```
+
+### Resource objects
+
+`Patient` and `Exercise` objects proxy attribute access to the underlying API response, so any field returned by the API is accessible directly:
+
+```python
+patient = client.get_patient("550e8400-e29b-41d4-a716-446655440000")
+patient.id        # any field in the JSON response
+patient["name"]   # dict-style access also works
+```
+
+### Lifecycle
+
+Use the client as a context manager (recommended) to ensure the underlying HTTP session is closed:
+
+```python
+with Client(...) as client:
+    ...
+```
+
+Or manage it manually:
+
+```python
+client = Client(...)
+try:
+    ...
+finally:
+    client.close()
+```
+
+## Development
+
+### Publishing
+
+This project uses [python-semantic-release](https://python-semantic-release.readthedocs.io/) with [Conventional Commits](https://www.conventionalcommits.org/) for automated versioning and publishing to PyPI via GitLab CI.
+
+Releases are triggered automatically on every push to the default branch when the commit history contains releasable changes:
+
+| Commit prefix | Version bump |
+|---|---|
+| `fix: ...` | Patch (0.1.0 → 0.1.1) |
+| `feat: ...` | Minor (0.1.0 → 0.2.0) |
+| `feat!: ...` / `BREAKING CHANGE:` | Major (0.1.0 → 1.0.0) |

eyesoft_api_client-0.1.0/eyesoft_api_client/__init__.py

@@ -0,0 +1,4 @@
+from .client import Client
+from .resources import Exercise, Patient
+
+__all__ = ["Client", "Exercise", "Patient"]

eyesoft_api_client-0.1.0/eyesoft_api_client/_http.py

@@ -0,0 +1,71 @@
+from typing import Any
+
+import httpx
+
+
+class HTTPSession:
+    """Thin wrapper around httpx.Client that holds auth and base URL."""
+
+    def __init__(self, base_url: str, username: str, password: str, client_id: str, client_secret: str) -> None:
+        self._client = httpx.Client(
+            base_url=base_url,
+            headers={"Accept": "application/json"},
+        )
+        self._login(username, password, client_id, client_secret)
+
+    # ------------------------------------------------------------------
+    # HTTP verbs
+    # ------------------------------------------------------------------
+
+    def get(self, path: str, **kwargs: Any) -> Any:
+        return self._request("GET", path, **kwargs)
+
+    def post(self, path: str, **kwargs: Any) -> Any:
+        return self._request("POST", path, **kwargs)
+
+    def put(self, path: str, **kwargs: Any) -> Any:
+        return self._request("PUT", path, **kwargs)
+
+    def patch(self, path: str, **kwargs: Any) -> Any:
+        return self._request("PATCH", path, **kwargs)
+
+    def delete(self, path: str, **kwargs: Any) -> Any:
+        return self._request("DELETE", path, **kwargs)
+
+    # ------------------------------------------------------------------
+    # Internal
+    # ------------------------------------------------------------------
+
+    def _request(self, method: str, path: str, **kwargs: Any) -> Any:
+        response = self._client.request(method, path, **kwargs)
+        response.raise_for_status()
+        if response.content:
+            return response.json()
+        return None
+
+    def _login(self, username: str, password: str, client_id: str, client_secret: str) -> None:
+        token = self.post(
+            "/oauth/v2/token",
+            data={
+                "grant_type": "password",
+                "scope": "SCOPE_USER",
+                "username": username,
+                "password": password,
+                "client_id": client_id,
+                "client_secret": client_secret,
+            },
+        )
+        self._client.headers["Authorization"] = f"Bearer {token['access_token']}"
+
+    # ------------------------------------------------------------------
+    # Context manager / cleanup
+    # ------------------------------------------------------------------
+
+    def close(self) -> None:
+        self._client.close()
+
+    def __enter__(self) -> "HTTPSession":
+        return self
+
+    def __exit__(self, *args: Any) -> None:
+        self.close()

eyesoft_api_client-0.1.0/eyesoft_api_client/client.py

@@ -0,0 +1,62 @@
+import json
+
+from ._http import HTTPSession
+from .resources.patient import Patient
+from .resources.exercise import Exercise
+
+from typing import Any
+
+
+class Client:
+    """
+    Entry point for the Eyesoft API.
+
+    Usage::
+
+        client = Client("https://api.example.com", "user", "pass", "client_id", "client_secret")
+        patients = client.list_patients()
+        exercises = patients[0].list_exercises()
+        client.close()
+
+    Or as a context manager::
+
+        with Client("https://api.example.com", "user", "pass", "client_id", "client_secret") as client:
+            patients = client.list_patients()
+    """
+
+    def __init__(self, base_url: str, username: str, password: str, client_id: str, client_secret: str) -> None:
+        self._http = HTTPSession(base_url, username, password, client_id, client_secret)
+
+    # ------------------------------------------------------------------
+    # Patients
+    # ------------------------------------------------------------------
+
+    def list_patients(self) -> list[Patient]:
+        data = self._http.get("/api/patients")
+        return [Patient(item, self._http) for item in data]
+
+    def get_patient(self, patient_id: str) -> Patient:
+        data = self._http.get(f"/api/patients/{patient_id}")
+        return Patient(data, self._http)
+
+    # ------------------------------------------------------------------
+    # Exercises
+    # ------------------------------------------------------------------
+
+    def get_exercise_data(self, exercise_id: str) -> Any:
+        data = self._http.get(f"/api/exercices/{exercise_id}/data")
+        parsed_data = json.loads(data)
+        return parsed_data
+
+    # ------------------------------------------------------------------
+    # Context manager / cleanup
+    # ------------------------------------------------------------------
+
+    def close(self) -> None:
+        self._http.close()
+
+    def __enter__(self) -> "Client":
+        return self
+
+    def __exit__(self, *args: object) -> None:
+        self.close()

eyesoft_api_client-0.1.0/eyesoft_api_client/resources/__init__.py

@@ -0,0 +1,4 @@
+from .exercise import Exercise
+from .patient import Patient
+
+__all__ = ["Exercise", "Patient"]

eyesoft_api_client-0.1.0/eyesoft_api_client/resources/base.py

@@ -0,0 +1,44 @@
+from typing import TYPE_CHECKING, Any
+
+if TYPE_CHECKING:
+    from eyesoft_api_client._http import HTTPSession
+
+
+class BaseResource:
+    """
+    Base class for all API resource objects.
+
+    Subclasses receive raw JSON data from the API and a shared HTTP session.
+    Attribute access is forwarded to the underlying data dict, so you can
+    write ``patient.id`` instead of ``patient._data["id"]``.
+    """
+
+    def __init__(self, data: dict[str, Any], http: "HTTPSession") -> None:
+        # Use object.__setattr__ to avoid triggering our own __setattr__
+        object.__setattr__(self, "_data", data)
+        object.__setattr__(self, "_http", http)
+
+    # ------------------------------------------------------------------
+    # Attribute / item access
+    # ------------------------------------------------------------------
+
+    def __getattr__(self, name: str) -> Any:
+        data = object.__getattribute__(self, "_data")
+        try:
+            return data[name]
+        except KeyError:
+            raise AttributeError(
+                f"'{type(self).__name__}' has no attribute '{name}'"
+            )
+
+    def __getitem__(self, key: str) -> Any:
+        return object.__getattribute__(self, "_data")[key]
+
+    # ------------------------------------------------------------------
+    # Representation
+    # ------------------------------------------------------------------
+
+    def __repr__(self) -> str:
+        data = object.__getattribute__(self, "_data")
+        preview = {k: v for k, v in list(data.items())[:3]}
+        return f"{type(self).__name__}({preview})"

eyesoft_api_client-0.1.0/eyesoft_api_client/resources/exercise.py

@@ -0,0 +1,13 @@
+import json
+from typing import Any
+
+from .base import BaseResource
+
+
+class Exercise(BaseResource):
+    """Represents a single exercise returned by the API."""
+
+    def get_data(self) -> Any:
+        data = self._http.get(f"/api/exercices/{self.id}/data")
+        parsed_data = json.loads(data)
+        return parsed_data

eyesoft_api_client-0.1.0/eyesoft_api_client/resources/patient.py

@@ -0,0 +1,14 @@
+from .base import BaseResource
+from .exercise import Exercise
+
+
+class Patient(BaseResource):
+    """Represents a single patient returned by the API."""
+
+    def list_exercises(self) -> list[Exercise]:
+        data = self._http.get(f"/api/patients/{self.id}/stats/history/evaluation")
+        return [Exercise(item, self._http) for item in data]
+
+    def get_exercise(self, exercise_id: str) -> Exercise:
+        data = self._http.get(f"/patients/{self.id}/exercises/{exercise_id}")
+        return Exercise(data, self._http)

eyesoft_api_client-0.1.0/pyproject.toml

@@ -0,0 +1,17 @@
+[project]
+name = "eyesoft-api-client"
+version = "0.1.0"
+description = ""
+authors = [
+    {name = "Arnaud-Marie Gallardo",email = "arnaud.g@eyesoft.fr"}
+]
+readme = "README.md"
+requires-python = ">=3.13"
+dependencies = [
+    "httpx (>=0.28.1,<0.29.0)"
+]
+
+
+[build-system]
+requires = ["poetry-core>=2.0.0,<3.0.0"]
+build-backend = "poetry.core.masonry.api"