didupwrapper 0.1.0__tar.gz

didupwrapper-0.1.0/PKG-INFO

@@ -0,0 +1,181 @@
+Metadata-Version: 2.4
+Name: didupwrapper
+Version: 0.1.0
+Summary: Wrapper Python (sync + async) per le API non documentate del registro elettronico DiDUP / Argo Famiglia
+Project-URL: Homepage, https://github.com/Rocciadura/DiDup-API-Wrapper
+Project-URL: Issues, https://github.com/Rocciadura/DiDup-API-Wrapper/issues
+Author: didupwrapper contributors
+License: MIT
+Keywords: api,argo,didup,registro elettronico,scuola,wrapper
+Classifier: Development Status :: 3 - Alpha
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Typing :: Typed
+Requires-Python: >=3.10
+Requires-Dist: httpx>=0.27
+Requires-Dist: pydantic>=2.6
+Provides-Extra: dev
+Requires-Dist: mypy>=1.8; extra == 'dev'
+Requires-Dist: pytest-asyncio>=0.23; extra == 'dev'
+Requires-Dist: pytest>=8.0; extra == 'dev'
+Requires-Dist: respx>=0.21; extra == 'dev'
+Requires-Dist: ruff>=0.4; extra == 'dev'
+Description-Content-Type: text/markdown
+
+<<<<<<< HEAD
+# DiDup-API-Wrapper
+Didup API Wrapper | ARGO SOFTWARE
+=======
+# didupwrapper
+
+Wrapper Python **open-source** (sync + async) per le API **non documentate** del
+registro elettronico **DiDUP / Argo Famiglia**
+
+> Le API non sono pubbliche né documentate da Argo. Questa libreria è basata
+> su reverse-engineering del traffico dell'app. Usala in modo responsabile e
+> solo con le tue credenziali.
+>
+> Il login usa il vero flusso **OAuth2/PKCE** dell'app DidUP Famiglia. L'header
+> `argo-client-version` deve combaciare con l'ultima versione dell'app sugli
+> store (attualmente **1.29.2**): se diventa obsoleto il server risponde `410`.
+
+### Versione client (`argo-client-version`)
+
+Tre modi, in ordine di priorità:
+
+```python
+# 1) Versione fissa di default (1.29.2)
+DiDUPClient("SC12345", "user", "pwd")
+
+# 2) Versione fissa esplicita
+DiDUPClient("SC12345", "user", "pwd", version="1.29.2")
+
+# 3) Auto-rilevamento dall'App Store al login (sempre aggiornata)
+DiDUPClient("SC12345", "user", "pwd", auto_versione=True)
+```
+
+Puoi anche solo interrogare lo store:
+
+```python
+from didupwrapper import recupera_versione_app
+print(await recupera_versione_app())  # es. "1.29.2"
+```
+
+## Caratteristiche
+
+- Python 3.10+
+- Client **async** (`DiDUPClient`) e **sync** (`DiDUPClientSync`)
+- Modelli **Pydantic v2** con alias camelCase automatici
+- Eccezioni tipizzate: `AuthError`, `RateLimitError`, `NotFoundError`, `DiDUPError`
+- Worker `DashboardPoller` per ricevere notifiche di novità (voti, bacheca, ...)
+- Packaging con `hatchling` + `pyproject.toml`
+
+## Installazione
+
+```bash
+pip install didupwrapper        
+```
+
+## Uso rapido
+
+### Async
+
+```python
+import asyncio
+from didupwrapper import DiDUPClient
+
+async def main():
+    async with DiDUPClient("SC12345", "mario.rossi", "password") as didup:
+        print("Media:", await didup.get_media_generale())
+        for voto in await didup.get_voti():
+            print(voto.des_materia, voto.cod_codice)
+
+asyncio.run(main())
+```
+
+### Sync
+
+```python
+from didupwrapper import DiDUPClientSync
+
+with DiDUPClientSync("SC12345", "mario.rossi", "password") as didup:
+    for voto in didup.get_voti():
+        print(voto.des_materia, voto.cod_codice)
+```
+
+## Metodi principali
+
+Tutti disponibili sia sul client async (con `await`) che su quello sync:
+
+| Metodo | Ritorna |
+|---|---|
+| `get_dashboard()` | `DashboardResponse` (dati aggregati) |
+| `get_voti()` | `list[Voto]` |
+| `get_assenze()` | `list[EventoAppello]` |
+| `get_registro()` | `list[RegistroLezione]` |
+| `get_bacheca()` | `list[ComunicazioneBacheca]` |
+| `get_bacheca_alunno()` | `list[FileBachecaAlunno]` |
+| `get_promemoria()` | `list[Promemoria]` |
+| `get_fuori_classe()` | `list[FuoriClasse]` |
+| `get_note_disciplinari()` | `list[NotaDisciplinare]` |
+| `get_materie()` | `list[Materia]` |
+| `get_docenti()` | `list[Docente]` |
+| `get_periodi()` | `list[Periodo]` |
+| `get_prenotazioni()` | `list[Prenotazione]` |
+| `get_media_generale()` | `float \| None` |
+
+### Endpoint con filtri
+
+Il client async espone anche oggetti endpoint con metodi di filtro:
+
+```python
+await didup.voti.per_materia(101)
+await didup.voti.media_per_materia(101)
+await didup.assenze.da_giustificare()
+await didup.bacheca.da_leggere()
+await didup.registro.compiti()
+await didup.fuori_classe.online()
+```
+
+## Monitoraggio (poller)
+
+```python
+from didupwrapper.workers import DashboardPoller
+
+async def on_voti(nuovi):
+    for v in nuovi:
+        print("Nuovo voto:", v.des_materia, v.cod_codice)
+
+poller = DashboardPoller(didup, intervallo=600, on_nuovi_voti=on_voti)
+await poller.avvia()   # ferma con poller.ferma()
+```
+
+## Licenza
+
+'''
+MIT License
+
+Copyright (c) 2026 Rocciadura
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.
+'''
+>>>>>>> 4017c03 (first commit)

didupwrapper-0.1.0/README.md

@@ -0,0 +1,154 @@
+<<<<<<< HEAD
+# DiDup-API-Wrapper
+Didup API Wrapper | ARGO SOFTWARE
+=======
+# didupwrapper
+
+Wrapper Python **open-source** (sync + async) per le API **non documentate** del
+registro elettronico **DiDUP / Argo Famiglia**
+
+> Le API non sono pubbliche né documentate da Argo. Questa libreria è basata
+> su reverse-engineering del traffico dell'app. Usala in modo responsabile e
+> solo con le tue credenziali.
+>
+> Il login usa il vero flusso **OAuth2/PKCE** dell'app DidUP Famiglia. L'header
+> `argo-client-version` deve combaciare con l'ultima versione dell'app sugli
+> store (attualmente **1.29.2**): se diventa obsoleto il server risponde `410`.
+
+### Versione client (`argo-client-version`)
+
+Tre modi, in ordine di priorità:
+
+```python
+# 1) Versione fissa di default (1.29.2)
+DiDUPClient("SC12345", "user", "pwd")
+
+# 2) Versione fissa esplicita
+DiDUPClient("SC12345", "user", "pwd", version="1.29.2")
+
+# 3) Auto-rilevamento dall'App Store al login (sempre aggiornata)
+DiDUPClient("SC12345", "user", "pwd", auto_versione=True)
+```
+
+Puoi anche solo interrogare lo store:
+
+```python
+from didupwrapper import recupera_versione_app
+print(await recupera_versione_app())  # es. "1.29.2"
+```
+
+## Caratteristiche
+
+- Python 3.10+
+- Client **async** (`DiDUPClient`) e **sync** (`DiDUPClientSync`)
+- Modelli **Pydantic v2** con alias camelCase automatici
+- Eccezioni tipizzate: `AuthError`, `RateLimitError`, `NotFoundError`, `DiDUPError`
+- Worker `DashboardPoller` per ricevere notifiche di novità (voti, bacheca, ...)
+- Packaging con `hatchling` + `pyproject.toml`
+
+## Installazione
+
+```bash
+pip install didupwrapper        
+```
+
+## Uso rapido
+
+### Async
+
+```python
+import asyncio
+from didupwrapper import DiDUPClient
+
+async def main():
+    async with DiDUPClient("SC12345", "mario.rossi", "password") as didup:
+        print("Media:", await didup.get_media_generale())
+        for voto in await didup.get_voti():
+            print(voto.des_materia, voto.cod_codice)
+
+asyncio.run(main())
+```
+
+### Sync
+
+```python
+from didupwrapper import DiDUPClientSync
+
+with DiDUPClientSync("SC12345", "mario.rossi", "password") as didup:
+    for voto in didup.get_voti():
+        print(voto.des_materia, voto.cod_codice)
+```
+
+## Metodi principali
+
+Tutti disponibili sia sul client async (con `await`) che su quello sync:
+
+| Metodo | Ritorna |
+|---|---|
+| `get_dashboard()` | `DashboardResponse` (dati aggregati) |
+| `get_voti()` | `list[Voto]` |
+| `get_assenze()` | `list[EventoAppello]` |
+| `get_registro()` | `list[RegistroLezione]` |
+| `get_bacheca()` | `list[ComunicazioneBacheca]` |
+| `get_bacheca_alunno()` | `list[FileBachecaAlunno]` |
+| `get_promemoria()` | `list[Promemoria]` |
+| `get_fuori_classe()` | `list[FuoriClasse]` |
+| `get_note_disciplinari()` | `list[NotaDisciplinare]` |
+| `get_materie()` | `list[Materia]` |
+| `get_docenti()` | `list[Docente]` |
+| `get_periodi()` | `list[Periodo]` |
+| `get_prenotazioni()` | `list[Prenotazione]` |
+| `get_media_generale()` | `float \| None` |
+
+### Endpoint con filtri
+
+Il client async espone anche oggetti endpoint con metodi di filtro:
+
+```python
+await didup.voti.per_materia(101)
+await didup.voti.media_per_materia(101)
+await didup.assenze.da_giustificare()
+await didup.bacheca.da_leggere()
+await didup.registro.compiti()
+await didup.fuori_classe.online()
+```
+
+## Monitoraggio (poller)
+
+```python
+from didupwrapper.workers import DashboardPoller
+
+async def on_voti(nuovi):
+    for v in nuovi:
+        print("Nuovo voto:", v.des_materia, v.cod_codice)
+
+poller = DashboardPoller(didup, intervallo=600, on_nuovi_voti=on_voti)
+await poller.avvia()   # ferma con poller.ferma()
+```
+
+## Licenza
+
+'''
+MIT License
+
+Copyright (c) 2026 Rocciadura
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.
+'''
+>>>>>>> 4017c03 (first commit)

didupwrapper-0.1.0/__init__.py

@@ -0,0 +1,100 @@
+"""didupwrapper — wrapper Python (sync + async) per le API non documentate
+del registro elettronico DiDUP / Argo Famiglia.
+
+Uso rapido (async)::
+
+    import asyncio
+    from didupwrapper import DiDUPClient
+
+    async def main():
+        async with DiDUPClient("SC12345", "mario.rossi", "password") as didup:
+            for voto in await didup.get_voti():
+                print(voto.des_materia, voto.cod_codice)
+
+    asyncio.run(main())
+
+Uso rapido (sync)::
+
+    from didupwrapper import DiDUPClientSync
+
+    with DiDUPClientSync("SC12345", "mario.rossi", "password") as didup:
+        print(didup.get_media_generale())
+"""
+
+from __future__ import annotations
+
+from .auth import (
+    ArgoConfig,
+    Autenticatore,
+    Credenziali,
+    LoginLink,
+    SessioneToken,
+    recupera_versione_app,
+)
+from .client import DiDUPClient, DiDUPClientSync
+from .exceptions import (
+    AuthError,
+    DiDUPError,
+    NotFoundError,
+    RateLimitError,
+)
+from .models import (
+    Allegato,
+    ComunicazioneBacheca,
+    Compito,
+    DashboardResponse,
+    DettaglioPrenotazione,
+    Docente,
+    EventoAppello,
+    FileBachecaAlunno,
+    FuoriClasse,
+    Materia,
+    NotaDisciplinare,
+    Periodo,
+    Prenotazione,
+    Promemoria,
+    RegistroLezione,
+    Voto,
+)
+from .workers import DashboardPoller, EventoPoller
+
+__version__ = "0.1.0"
+
+__all__ = [
+    "__version__",
+    # client
+    "DiDUPClient",
+    "DiDUPClientSync",
+    # auth
+    "ArgoConfig",
+    "Autenticatore",
+    "Credenziali",
+    "SessioneToken",
+    "LoginLink",
+    "recupera_versione_app",
+    # eccezioni
+    "DiDUPError",
+    "AuthError",
+    "RateLimitError",
+    "NotFoundError",
+    # modelli
+    "DashboardResponse",
+    "Voto",
+    "EventoAppello",
+    "RegistroLezione",
+    "Compito",
+    "NotaDisciplinare",
+    "Promemoria",
+    "ComunicazioneBacheca",
+    "Allegato",
+    "FileBachecaAlunno",
+    "FuoriClasse",
+    "Materia",
+    "Docente",
+    "Periodo",
+    "Prenotazione",
+    "DettaglioPrenotazione",
+    # workers
+    "DashboardPoller",
+    "EventoPoller",
+]