hackbou-push-notification 0.1.0__tar.gz

hackbou_push_notification-0.1.0/PKG-INFO

@@ -0,0 +1,122 @@
+Metadata-Version: 2.4
+Name: hackbou-push-notification
+Version: 0.1.0
+Summary: Client Python / Django pour l'API Push Notification
+Author-email: hackbou <hackbou@users.noreply.github.com>
+License: Apache-2.0
+Project-URL: Homepage, https://github.com/hardhacklife/push-notification-python-sdk
+Project-URL: Documentation, https://github.com/hardhacklife/push-notification-python-sdk#readme
+Project-URL: Repository, https://github.com/hardhacklife/push-notification-python-sdk
+Project-URL: Issues, https://github.com/hardhacklife/push-notification-python-sdk/issues
+Keywords: push-notification,push,notifications,django,fcm,apns
+Classifier: Development Status :: 3 - Alpha
+Classifier: Framework :: Django
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: Apache Software License
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Typing :: Typed
+Classifier: Topic :: Communications
+Requires-Python: >=3.10
+Description-Content-Type: text/markdown
+Requires-Dist: httpx>=0.27
+Requires-Dist: typing_extensions>=4.5; python_version < "3.11"
+Provides-Extra: django
+Requires-Dist: Django>=4.2; extra == "django"
+Provides-Extra: dev
+Requires-Dist: pytest>=8.0; extra == "dev"
+Requires-Dist: build; extra == "dev"
+Requires-Dist: twine; extra == "dev"
+
+# hackbou-push-notification
+
+Client Python / Django pour l’API **Push Notification**.
+
+Typage : PEP 561 (`py.typed`) + `TypedDict` pour les réponses.
+
+**Import :** `push_notification`  
+**Package PyPI :** `hackbou-push-notification`
+
+## Installation
+
+```bash
+pip install hackbou-push-notification
+
+# avec helpers Django
+pip install "hackbou-push-notification[django]"
+```
+
+## Usage Python
+
+```python
+from push_notification import PushNotificationClient, Device, NotificationCreateResult
+
+with PushNotificationClient(
+    api_key="pf_live_…",
+    base_url="https://push.example.com",
+) as push:
+    result: NotificationCreateResult = push.send_notification(
+        title="Nouveau cours",
+        body="Le support est disponible.",
+        user_ids=["student_123"],
+        data={"screen": "course"},
+    )
+    devices: list[Device] = push.list_devices(limit=50)
+    page = push.list_devices_page(q="expo", limit=25, offset=0)
+```
+
+## Usage Django
+
+`settings.py` :
+
+```python
+PUSH_NOTIFICATION_API_KEY = env("PUSH_NOTIFICATION_API_KEY")
+PUSH_NOTIFICATION_BASE_URL = env("PUSH_NOTIFICATION_BASE_URL", default="http://127.0.0.1:8787")
+PUSH_NOTIFICATION_TIMEOUT = 15
+```
+
+```python
+from push_notification.django import send_to_user, get_client
+
+send_to_user(
+    "student_123",
+    title="Nouveau cours",
+    body="Un support vient d’être publié.",
+    data={"course_id": "math_101"},
+)
+
+client = get_client()
+client.login_user("student_123", device_ids=["…"])
+client.set_user_tags("student_123", {"language": "fr"})
+```
+
+## API du client
+
+| Méthode | Endpoint |
+|---------|----------|
+| `register_device(platform=, token=)` | `POST /v1/devices` |
+| `list_devices(q=, limit=, offset=)` | `GET /v1/devices` → `list[Device]` |
+| `list_devices_page(…)` | idem → `{items,total,limit,offset,has_more}` |
+| `delete_device(id)` | `DELETE /v1/devices/{id}` |
+| `login` / `login_user` | `POST /v1/users/…/login` |
+| `set_tags` / `set_user_tags` | `PUT /v1/users/…/tags` |
+| `list_users` / `list_users_page` | `GET /v1/users` |
+| `send_notification(…)` | `POST /v1/notifications` |
+| `get_notification(id)` | `GET /v1/notifications/{id}` |
+| `list_notifications` / `_page` | `GET /v1/notifications` |
+| `health_live()` / `health_ready()` | healthchecks |
+
+Les listes acceptent l’enveloppe paginée **et** un ancien tableau brut (compat).
+
+## Tests
+
+```bash
+pip install -e ".[dev]"
+pytest
+```
+
+## Licence
+
+Apache-2.0

hackbou_push_notification-0.1.0/README.md

@@ -0,0 +1,90 @@
+# hackbou-push-notification
+
+Client Python / Django pour l’API **Push Notification**.
+
+Typage : PEP 561 (`py.typed`) + `TypedDict` pour les réponses.
+
+**Import :** `push_notification`  
+**Package PyPI :** `hackbou-push-notification`
+
+## Installation
+
+```bash
+pip install hackbou-push-notification
+
+# avec helpers Django
+pip install "hackbou-push-notification[django]"
+```
+
+## Usage Python
+
+```python
+from push_notification import PushNotificationClient, Device, NotificationCreateResult
+
+with PushNotificationClient(
+    api_key="pf_live_…",
+    base_url="https://push.example.com",
+) as push:
+    result: NotificationCreateResult = push.send_notification(
+        title="Nouveau cours",
+        body="Le support est disponible.",
+        user_ids=["student_123"],
+        data={"screen": "course"},
+    )
+    devices: list[Device] = push.list_devices(limit=50)
+    page = push.list_devices_page(q="expo", limit=25, offset=0)
+```
+
+## Usage Django
+
+`settings.py` :
+
+```python
+PUSH_NOTIFICATION_API_KEY = env("PUSH_NOTIFICATION_API_KEY")
+PUSH_NOTIFICATION_BASE_URL = env("PUSH_NOTIFICATION_BASE_URL", default="http://127.0.0.1:8787")
+PUSH_NOTIFICATION_TIMEOUT = 15
+```
+
+```python
+from push_notification.django import send_to_user, get_client
+
+send_to_user(
+    "student_123",
+    title="Nouveau cours",
+    body="Un support vient d’être publié.",
+    data={"course_id": "math_101"},
+)
+
+client = get_client()
+client.login_user("student_123", device_ids=["…"])
+client.set_user_tags("student_123", {"language": "fr"})
+```
+
+## API du client
+
+| Méthode | Endpoint |
+|---------|----------|
+| `register_device(platform=, token=)` | `POST /v1/devices` |
+| `list_devices(q=, limit=, offset=)` | `GET /v1/devices` → `list[Device]` |
+| `list_devices_page(…)` | idem → `{items,total,limit,offset,has_more}` |
+| `delete_device(id)` | `DELETE /v1/devices/{id}` |
+| `login` / `login_user` | `POST /v1/users/…/login` |
+| `set_tags` / `set_user_tags` | `PUT /v1/users/…/tags` |
+| `list_users` / `list_users_page` | `GET /v1/users` |
+| `send_notification(…)` | `POST /v1/notifications` |
+| `get_notification(id)` | `GET /v1/notifications/{id}` |
+| `list_notifications` / `_page` | `GET /v1/notifications` |
+| `health_live()` / `health_ready()` | healthchecks |
+
+Les listes acceptent l’enveloppe paginée **et** un ancien tableau brut (compat).
+
+## Tests
+
+```bash
+pip install -e ".[dev]"
+pytest
+```
+
+## Licence
+
+Apache-2.0

hackbou_push_notification-0.1.0/hackbou_push_notification.egg-info/PKG-INFO

@@ -0,0 +1,122 @@
+Metadata-Version: 2.4
+Name: hackbou-push-notification
+Version: 0.1.0
+Summary: Client Python / Django pour l'API Push Notification
+Author-email: hackbou <hackbou@users.noreply.github.com>
+License: Apache-2.0
+Project-URL: Homepage, https://github.com/hardhacklife/push-notification-python-sdk
+Project-URL: Documentation, https://github.com/hardhacklife/push-notification-python-sdk#readme
+Project-URL: Repository, https://github.com/hardhacklife/push-notification-python-sdk
+Project-URL: Issues, https://github.com/hardhacklife/push-notification-python-sdk/issues
+Keywords: push-notification,push,notifications,django,fcm,apns
+Classifier: Development Status :: 3 - Alpha
+Classifier: Framework :: Django
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: Apache Software License
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Typing :: Typed
+Classifier: Topic :: Communications
+Requires-Python: >=3.10
+Description-Content-Type: text/markdown
+Requires-Dist: httpx>=0.27
+Requires-Dist: typing_extensions>=4.5; python_version < "3.11"
+Provides-Extra: django
+Requires-Dist: Django>=4.2; extra == "django"
+Provides-Extra: dev
+Requires-Dist: pytest>=8.0; extra == "dev"
+Requires-Dist: build; extra == "dev"
+Requires-Dist: twine; extra == "dev"
+
+# hackbou-push-notification
+
+Client Python / Django pour l’API **Push Notification**.
+
+Typage : PEP 561 (`py.typed`) + `TypedDict` pour les réponses.
+
+**Import :** `push_notification`  
+**Package PyPI :** `hackbou-push-notification`
+
+## Installation
+
+```bash
+pip install hackbou-push-notification
+
+# avec helpers Django
+pip install "hackbou-push-notification[django]"
+```
+
+## Usage Python
+
+```python
+from push_notification import PushNotificationClient, Device, NotificationCreateResult
+
+with PushNotificationClient(
+    api_key="pf_live_…",
+    base_url="https://push.example.com",
+) as push:
+    result: NotificationCreateResult = push.send_notification(
+        title="Nouveau cours",
+        body="Le support est disponible.",
+        user_ids=["student_123"],
+        data={"screen": "course"},
+    )
+    devices: list[Device] = push.list_devices(limit=50)
+    page = push.list_devices_page(q="expo", limit=25, offset=0)
+```
+
+## Usage Django
+
+`settings.py` :
+
+```python
+PUSH_NOTIFICATION_API_KEY = env("PUSH_NOTIFICATION_API_KEY")
+PUSH_NOTIFICATION_BASE_URL = env("PUSH_NOTIFICATION_BASE_URL", default="http://127.0.0.1:8787")
+PUSH_NOTIFICATION_TIMEOUT = 15
+```
+
+```python
+from push_notification.django import send_to_user, get_client
+
+send_to_user(
+    "student_123",
+    title="Nouveau cours",
+    body="Un support vient d’être publié.",
+    data={"course_id": "math_101"},
+)
+
+client = get_client()
+client.login_user("student_123", device_ids=["…"])
+client.set_user_tags("student_123", {"language": "fr"})
+```
+
+## API du client
+
+| Méthode | Endpoint |
+|---------|----------|
+| `register_device(platform=, token=)` | `POST /v1/devices` |
+| `list_devices(q=, limit=, offset=)` | `GET /v1/devices` → `list[Device]` |
+| `list_devices_page(…)` | idem → `{items,total,limit,offset,has_more}` |
+| `delete_device(id)` | `DELETE /v1/devices/{id}` |
+| `login` / `login_user` | `POST /v1/users/…/login` |
+| `set_tags` / `set_user_tags` | `PUT /v1/users/…/tags` |
+| `list_users` / `list_users_page` | `GET /v1/users` |
+| `send_notification(…)` | `POST /v1/notifications` |
+| `get_notification(id)` | `GET /v1/notifications/{id}` |
+| `list_notifications` / `_page` | `GET /v1/notifications` |
+| `health_live()` / `health_ready()` | healthchecks |
+
+Les listes acceptent l’enveloppe paginée **et** un ancien tableau brut (compat).
+
+## Tests
+
+```bash
+pip install -e ".[dev]"
+pytest
+```
+
+## Licence
+
+Apache-2.0

hackbou_push_notification-0.1.0/hackbou_push_notification.egg-info/SOURCES.txt

@@ -0,0 +1,18 @@
+README.md
+pyproject.toml
+setup.py
+hackbou_push_notification.egg-info/PKG-INFO
+hackbou_push_notification.egg-info/SOURCES.txt
+hackbou_push_notification.egg-info/dependency_links.txt
+hackbou_push_notification.egg-info/requires.txt
+hackbou_push_notification.egg-info/top_level.txt
+push_notification/__init__.py
+push_notification/_parse.py
+push_notification/client.py
+push_notification/django.py
+push_notification/exceptions.py
+push_notification/models.py
+push_notification/py.typed
+tests/test_client.py
+tests/test_exceptions.py
+tests/test_parse.py

hackbou_push_notification-0.1.0/hackbou_push_notification.egg-info/dependency_links.txt

@@ -0,0 +1 @@
+

hackbou_push_notification-0.1.0/hackbou_push_notification.egg-info/requires.txt

@@ -0,0 +1,12 @@
+httpx>=0.27
+
+[:python_version < "3.11"]
+typing_extensions>=4.5
+
+[dev]
+pytest>=8.0
+build
+twine
+
+[django]
+Django>=4.2

hackbou_push_notification-0.1.0/hackbou_push_notification.egg-info/top_level.txt

@@ -0,0 +1 @@
+push_notification

hackbou_push_notification-0.1.0/push_notification/__init__.py

@@ -0,0 +1,27 @@
+"""Client Python PushNotification."""
+
+from .client import PushNotificationClient
+from .exceptions import PushNotificationError
+from .models import (
+    DeliverySummary,
+    Device,
+    NotificationCreateResult,
+    NotificationDetail,
+    Page,
+    TagsResponse,
+    User,
+)
+
+__all__ = [
+    "PushNotificationClient",
+    "PushNotificationError",
+    "Device",
+    "User",
+    "Page",
+    "TagsResponse",
+    "DeliverySummary",
+    "NotificationCreateResult",
+    "NotificationDetail",
+    "__version__",
+]
+__version__ = "0.1.1"

hackbou_push_notification-0.1.0/push_notification/_parse.py

@@ -0,0 +1,127 @@
+"""Helpers de parsing défensifs — ne jamais faire confiance au JSON brut."""
+
+from __future__ import annotations
+
+from typing import Any, cast
+
+from .exceptions import PushNotificationError
+from .models import Device, JsonDict, Page, User
+
+
+def _require_mapping(value: Any, label: str) -> JsonDict:
+    if not isinstance(value, dict):
+        raise PushNotificationError(
+            f"Réponse {label} invalide (objet attendu)",
+            code="invalid_response",
+        )
+    return cast(JsonDict, value)
+
+
+def _require_str(obj: JsonDict, key: str, label: str) -> str:
+    val = obj.get(key)
+    if not isinstance(val, str) or not val:
+        raise PushNotificationError(
+            f"Réponse {label} sans champ '{key}'",
+            code="invalid_response",
+        )
+    return val
+
+
+def parse_device(raw: Any) -> Device:
+    obj = _require_mapping(raw, "appareil")
+    device: Device = {
+        "id": _require_str(obj, "id", "appareil"),
+        "platform": str(obj.get("platform") or "unknown"),
+        "status": str(obj.get("status") or "unknown"),
+        "user_id": obj.get("user_id") if isinstance(obj.get("user_id"), str) else None,
+        "created_at": str(obj.get("created_at") or ""),
+        "updated_at": str(obj.get("updated_at") or ""),
+    }
+    if "last_seen_at" in obj:
+        device["last_seen_at"] = (
+            obj["last_seen_at"] if isinstance(obj["last_seen_at"], str) else None
+        )
+    if "external_user_id" in obj:
+        device["external_user_id"] = (
+            obj["external_user_id"]
+            if isinstance(obj["external_user_id"], str)
+            else None
+        )
+    if isinstance(obj.get("token_preview"), str):
+        device["token_preview"] = obj["token_preview"]
+    if isinstance(obj.get("token_kind"), str):
+        device["token_kind"] = obj["token_kind"]
+    if isinstance(obj.get("push_ready"), bool):
+        device["push_ready"] = obj["push_ready"]
+    return device
+
+
+def parse_user(raw: Any) -> User:
+    obj = _require_mapping(raw, "utilisateur")
+    return {
+        "id": _require_str(obj, "id", "utilisateur"),
+        "external_id": _require_str(obj, "external_id", "utilisateur"),
+        "created_at": str(obj.get("created_at") or ""),
+        "updated_at": str(obj.get("updated_at") or ""),
+    }
+
+
+def parse_tags(raw: Any) -> dict[str, str]:
+    obj = _require_mapping(raw, "tags")
+    tags_raw = obj.get("tags", {})
+    if not isinstance(tags_raw, dict):
+        return {}
+    out: dict[str, str] = {}
+    for key, value in tags_raw.items():
+        if isinstance(key, str) and isinstance(value, str):
+            out[key] = value
+        elif isinstance(key, str) and value is not None:
+            out[key] = str(value)
+    return out
+
+
+def parse_page(raw: Any, *, item_label: str = "item") -> Page:
+    """
+    Accepte l’enveloppe Page moderne **ou** un tableau legacy.
+    Toujours retourne {items,total,limit,offset,has_more}.
+    """
+    if isinstance(raw, list):
+        items = list(raw)
+        return {
+            "items": items,
+            "total": len(items),
+            "limit": len(items) or 25,
+            "offset": 0,
+            "has_more": False,
+        }
+
+    obj = _require_mapping(raw, f"page {item_label}")
+    items_raw = obj.get("items")
+    if not isinstance(items_raw, list):
+        # Ancien shape accidentel : objet unique
+        raise PushNotificationError(
+            f"Réponse page {item_label} sans 'items'",
+            code="invalid_response",
+        )
+
+    total = obj.get("total")
+    limit = obj.get("limit")
+    offset = obj.get("offset")
+    has_more = obj.get("has_more")
+
+    total_i = int(total) if isinstance(total, (int, float)) else len(items_raw)
+    limit_i = int(limit) if isinstance(limit, (int, float)) else max(len(items_raw), 1)
+    offset_i = int(offset) if isinstance(offset, (int, float)) else 0
+    has_more_b = (
+        bool(has_more)
+        if isinstance(has_more, bool)
+        else offset_i + len(items_raw) < total_i
+    )
+
+    return {
+        "items": items_raw,
+        "total": total_i,
+        "limit": limit_i,
+        "offset": offset_i,
+        "has_more": has_more_b,
+    }