<h1 align='center'>======= ClasseVivaAPI - Python =======</h1>
<br></br>
## Informazioni
[`ClasseVivaAPI`]() è una libreria <b>[`Python`](https://www.python.org/)</b> che permette di utlizzare l'API di <b>[`Classeviva`](https://web.spaggiari.eu/)</b> - <b>[`GruppoSpaggiariParma`](https://web.spaggiari.eu/www/app/default/index.php)</b> per ottenere informazioni come <b>Voti</b>, <b>Note</b> e <b>Documenti</b>, relative ad un account ClasseViva.
<br></br>
## Installa ClasseVivaAPI da [`PyPI`]()
```bash
pip install CVV-API
```
<br></br>
## Utilizzo
<b>Richiedi i VOTI di un utente (richiesta senza parametri):</b>
```py
from ClasseVivaAPI import Utente, RequestURLs
utente = Utente(uid="USERNAME", pwd="PASSWORD") # Crea un Utente utilizzando USERNAME e PASSWORD del tuo account ClasseViva
utente.login() # Effetua l'accesso all'account, verificando che i dati inseriti siano corretti
voti = utente.request(RequestURLs.voti) # Richiesta all'API (utente.request()) di ottenere i VOTI (ReqeusteURLs.voti) dell'utente dal quale si effettua la richiesta
print(voti.json()) # Stampa il risultato della richiesto nella console, in formato JSON
```
#
<b>Richiedi l'AGENDA di un utente (richiesta con parametri):</b>
```py
from ClasseVivaAPI import Utente, RequestURLs
utente = Utente(uid="USERNAME", pwd="PASSWORD") # Crea un Utente utilizzando USERNAME e PASSWORD del tuo account ClasseViva
utente.login() # Effetua l'accesso all'account, verificando che i dati inseriti siano corretti
voti = utente.request(RequestURLs.agenda, (20230301, 20230302)) # Richiesta all'API (utente.request()) di ottenere l'AGENDA (RequestURLs.agenda) dell'utente dal quale si effettua la richiesta, inserendo la data di inizio e di fine in formato AAAAMMGG (Esempio: '20230301' = 1 Marzo 2023)
print(voti.json()) # Stampa il risultato della richiesto nella console, in formato JSON
```
<br></br>
<br></br>
`` Utente ``
-------------------
<b>Rappresenta un utente di ClasseViva (di tipo studente)</b>
<br></br>
**Classe**
```py
class Utente()
```
<br></br>
**Costruttore**
```py
def __init__(
self,
uip: str,
pwd: str
) -> None:
```
   Parametri:
   - ``uid``: Username dell'utente
   - ``pwd``: Password dell'utente
<br></br>
**Attributi:**
- ``self.uid``: Username dell'utente
- ``self.pwd``: Password dell'utente
- ``self.ident``: Identificato dell'utente
- ``self.token``: Token della sessione
- ``self.is_logged_in``: Indica se l'utente ha effettuato l'accesso o meno
<br></br>
**Metodi:**
- ``self.login()``: Effettua l'accesso alla sessione di ClasseViva
```py
login(self) -> Response
```
- ``self.request()``: Invia una richiesta all'API di ClasseViva
```py
request(self, request_url: tuple, parmas=None) -> Response
```
<br></br>
<br></br>
`` RequestURLs ``
-------------------
<b>Rappresenta la lista di URL disponibili per le richieste all'API di ClasseViva</b>
<br></br>
**Classe**
```py
class RequestURLs()
```
<br></br>
**Attributi:**
- ``self.base_url``: URL di base per le richieste all'API di ClasseViva
- ``self.students_url``: URL di base per le richieste relative agli studenti
<br></br>
- ``self.assenze``: URL per ottenere le informazioni sulle assenze
- ``self.agenda``: URL per ottenere le informazioni sull'agenda
- ``self.didattica``: URL per ottenere le informazioni sulla didattica
- ``self.libri``: URL per ottenere le informazioni sui libri scolastici
- ``self.calendario``: URL per ottenere le informazioni sul calendario
- ``self.card``: URL per ottenere le informazioni sulla card dello studente
- ``self.voti``: URL per ottenere le informazioni sui voti
- ``self.lezioni_oggi``: URL per ottenere le informazioni sulle lezioni del giorno
- ``self.lezioni_giorno``: URL per ottenere le informazioni sulle lezioni di un giorno specifico
- ``self.note``: URL per ottenere le informazioni sulle note
- ``self.periods``: URL per ottenere le informazioni sui periodi
- ``self.materie``: URL per ottenere le informazioni sulle materie
- ``self.login`` URL per effettuare il login
- ``self.noticeboard``: URL per ottenere le informazioni sulla bacheca
- ``self.documenti``: URL per ottenere le informazioni sui documenti
<br></br>
<br></br>
## Contributi e Supporto
Se hai idee per migliorare questa libreria o hai riscontrato problemi, puoi contribuire aprendo issue o pull request su GitHub. Sarò felice di ricevere feedback e aiutarti nelle tue implementazioni.
<br></br>
## Licenza
Questa libreria è rilasciata con la licenza [`MIT License`](https://opensource.org/license/mit/).
Buon utilizzo della libreria ClasseVivaAPI!
Raw data
{
"_id": null,
"home_page": "https://github.com/MakerFaffa/ClasseVivaAPI",
"name": "CVV-API",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.10",
"maintainer_email": "",
"keywords": "classeviva,api,ClasseViva-API",
"author": "Fabrizio Gasparini",
"author_email": "gasparini.fabrizio@einaudicorreggio.it",
"download_url": "https://files.pythonhosted.org/packages/8c/bc/9ba318d32dcb29d82d8732c419ecccf38ff04b97c89ea0c102b3a20e32af/CVV-API-0.1.tar.gz",
"platform": null,
"description": "<h1 align='center'>======= ClasseVivaAPI - Python =======</h1>\r\n\r\n<br></br>\r\n\r\n## Informazioni\r\n\r\n[`ClasseVivaAPI`]() \u00c3\u00a8 una libreria <b>[`Python`](https://www.python.org/)</b> che permette di utlizzare l'API di <b>[`Classeviva`](https://web.spaggiari.eu/)</b> - <b>[`GruppoSpaggiariParma`](https://web.spaggiari.eu/www/app/default/index.php)</b> per ottenere informazioni come <b>Voti</b>, <b>Note</b> e <b>Documenti</b>, relative ad un account ClasseViva.\r\n\r\n<br></br>\r\n\r\n## Installa ClasseVivaAPI da [`PyPI`]()\r\n\r\n```bash\r\npip install CVV-API\r\n```\r\n<br></br>\r\n\r\n## Utilizzo\r\n\r\n<b>Richiedi i VOTI di un utente (richiesta senza parametri):</b>\r\n```py\r\nfrom ClasseVivaAPI import Utente, RequestURLs\r\n\r\nutente = Utente(uid=\"USERNAME\", pwd=\"PASSWORD\") # Crea un Utente utilizzando USERNAME e PASSWORD del tuo account ClasseViva\r\nutente.login() # Effetua l'accesso all'account, verificando che i dati inseriti siano corretti\r\n\r\nvoti = utente.request(RequestURLs.voti) # Richiesta all'API (utente.request()) di ottenere i VOTI (ReqeusteURLs.voti) dell'utente dal quale si effettua la richiesta\r\nprint(voti.json()) # Stampa il risultato della richiesto nella console, in formato JSON\r\n```\r\n#\r\n\r\n<b>Richiedi l'AGENDA di un utente (richiesta con parametri):</b>\r\n```py\r\nfrom ClasseVivaAPI import Utente, RequestURLs\r\n\r\nutente = Utente(uid=\"USERNAME\", pwd=\"PASSWORD\") # Crea un Utente utilizzando USERNAME e PASSWORD del tuo account ClasseViva\r\nutente.login() # Effetua l'accesso all'account, verificando che i dati inseriti siano corretti\r\n\r\nvoti = utente.request(RequestURLs.agenda, (20230301, 20230302)) # Richiesta all'API (utente.request()) di ottenere l'AGENDA (RequestURLs.agenda) dell'utente dal quale si effettua la richiesta, inserendo la data di inizio e di fine in formato AAAAMMGG (Esempio: '20230301' = 1 Marzo 2023)\r\nprint(voti.json()) # Stampa il risultato della richiesto nella console, in formato JSON\r\n```\r\n\r\n<br></br>\r\n<br></br>\r\n\r\n`` Utente ``\r\n-------------------\r\n\r\n<b>Rappresenta un utente di ClasseViva (di tipo studente)</b>\r\n\r\n<br></br>\r\n**Classe**\r\n```py\r\nclass Utente()\r\n```\r\n\r\n<br></br>\r\n**Costruttore**\r\n```py\r\ndef __init__(\r\n self,\r\n uip: str,\r\n pwd: str\r\n) -> None:\r\n```\r\n\r\n   Parametri:\r\n\r\n   - ``uid``: Username dell'utente\r\n\r\n   - ``pwd``: Password dell'utente\r\n\r\n\r\n<br></br>\r\n**Attributi:**\r\n - ``self.uid``: Username dell'utente\r\n - ``self.pwd``: Password dell'utente\r\n - ``self.ident``: Identificato dell'utente\r\n - ``self.token``: Token della sessione\r\n - ``self.is_logged_in``: Indica se l'utente ha effettuato l'accesso o meno\r\n\r\n<br></br>\r\n**Metodi:**\r\n - ``self.login()``: Effettua l'accesso alla sessione di ClasseViva\r\n```py\r\n login(self) -> Response\r\n```\r\n \r\n - ``self.request()``: Invia una richiesta all'API di ClasseViva\r\n```py\r\n request(self, request_url: tuple, parmas=None) -> Response\r\n```\r\n<br></br>\r\n<br></br>\r\n\r\n`` RequestURLs ``\r\n-------------------\r\n<b>Rappresenta la lista di URL disponibili per le richieste all'API di ClasseViva</b>\r\n\r\n<br></br>\r\n**Classe**\r\n```py\r\nclass RequestURLs()\r\n```\r\n\r\n<br></br>\r\n**Attributi:**\r\n- ``self.base_url``: URL di base per le richieste all'API di ClasseViva\r\n- ``self.students_url``: URL di base per le richieste relative agli studenti\r\n<br></br>\r\n- ``self.assenze``: URL per ottenere le informazioni sulle assenze\r\n- ``self.agenda``: URL per ottenere le informazioni sull'agenda\r\n- ``self.didattica``: URL per ottenere le informazioni sulla didattica\r\n- ``self.libri``: URL per ottenere le informazioni sui libri scolastici\r\n- ``self.calendario``: URL per ottenere le informazioni sul calendario\r\n- ``self.card``: URL per ottenere le informazioni sulla card dello studente\r\n- ``self.voti``: URL per ottenere le informazioni sui voti\r\n- ``self.lezioni_oggi``: URL per ottenere le informazioni sulle lezioni del giorno\r\n- ``self.lezioni_giorno``: URL per ottenere le informazioni sulle lezioni di un giorno specifico\r\n- ``self.note``: URL per ottenere le informazioni sulle note\r\n- ``self.periods``: URL per ottenere le informazioni sui periodi\r\n- ``self.materie``: URL per ottenere le informazioni sulle materie\r\n- ``self.login`` URL per effettuare il login\r\n- ``self.noticeboard``: URL per ottenere le informazioni sulla bacheca\r\n- ``self.documenti``: URL per ottenere le informazioni sui documenti\r\n\r\n<br></br>\r\n<br></br>\r\n\r\n## Contributi e Supporto\r\nSe hai idee per migliorare questa libreria o hai riscontrato problemi, puoi contribuire aprendo issue o pull request su GitHub. Sar\u00c3\u00b2 felice di ricevere feedback e aiutarti nelle tue implementazioni.\r\n\r\n<br></br>\r\n\r\n## Licenza\r\nQuesta libreria \u00c3\u00a8 rilasciata con la licenza [`MIT License`](https://opensource.org/license/mit/).\r\n\r\nBuon utilizzo della libreria ClasseVivaAPI!\r\n",
"bugtrack_url": null,
"license": "",
"summary": "ClasseViva-API \u00e8 una libreria Python che permette di utlizzare l'API di Classeviva - GruppoSpaggiariParma per ottenere informazioni come Voti, Note e Documenti, relative ad un account ClasseViva.",
"version": "0.1",
"project_urls": {
"Homepage": "https://github.com/MakerFaffa/ClasseVivaAPI"
},
"split_keywords": [
"classeviva",
"api",
"classeviva-api"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "1a9c352f6be5cc7985feb03a6955a07b8cb4f74912c2320e01b879253d25e964",
"md5": "8e854d73e64a2415125bf98fc84d0b23",
"sha256": "b6c60f3862605f11c2519b45e5799cb2ab8fb049119d9b456128e6e39a84455d"
},
"downloads": -1,
"filename": "CVV_API-0.1-py3-none-any.whl",
"has_sig": false,
"md5_digest": "8e854d73e64a2415125bf98fc84d0b23",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.10",
"size": 4234,
"upload_time": "2023-08-21T20:23:03",
"upload_time_iso_8601": "2023-08-21T20:23:03.041400Z",
"url": "https://files.pythonhosted.org/packages/1a/9c/352f6be5cc7985feb03a6955a07b8cb4f74912c2320e01b879253d25e964/CVV_API-0.1-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "8cbc9ba318d32dcb29d82d8732c419ecccf38ff04b97c89ea0c102b3a20e32af",
"md5": "4e5f65b125e0e92b8d4c054c4f46dbd5",
"sha256": "9d96bf33c4a3a6e0d125c7fe50d2588652b1c22c7a0479ee4fc0ec9008061bad"
},
"downloads": -1,
"filename": "CVV-API-0.1.tar.gz",
"has_sig": false,
"md5_digest": "4e5f65b125e0e92b8d4c054c4f46dbd5",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.10",
"size": 4041,
"upload_time": "2023-08-21T20:23:04",
"upload_time_iso_8601": "2023-08-21T20:23:04.779452Z",
"url": "https://files.pythonhosted.org/packages/8c/bc/9ba318d32dcb29d82d8732c419ecccf38ff04b97c89ea0c102b3a20e32af/CVV-API-0.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-08-21 20:23:04",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "MakerFaffa",
"github_project": "ClasseVivaAPI",
"github_not_found": true,
"lcname": "cvv-api"
}
JSON
