# AxiosStAPI
Wrapper in python per usufruire delle API di RE studenti di Axios Italia
## Getting started
### Logging in
```python
from AxiosStAPI.AxiosStAPI import AxiosStAPI
api = AxiosStAPI()
api.login(SCUOLA, USER, PASSWORD)
```
### Retrieving informations:
#### Senza Login
```python
# Ricerca delle scuole con una stringa che può essere nome, cap, via, ecc
api.retrieveAPPCustomerInformationByString(services.RetrieveAPPCustomerInformationByString.SSEARCH, query="20090")
#[{'fsIntitolazione': 'MICROTECH', 'fsNome': 'SRL', 'fsCF': '06830500960', 'fsCap': '20090', 'fsRegione': 'LOMBARDIA', 'fsCitta': 'BUCCINASCO', 'fsProvincia': 'MI'}, ...]
```
#### Con Login
Per la lista di tutti i servizi disponibili consulta [services.py](https://github.com/Invy55/AxiosStAPI/blob/main/AxiosStAPI/utils/services.py) e controlla l'implementazione in [AxiosStAPI.py](https://github.com/Invy55/AxiosStAPI/blob/main/AxiosStAPI/AxiosStAPI.py#L115-L130)
```python
# Ottieni avvenimenti di una giornata
api.retrieveDataInformation(services.RetrieveDataInformation.TIMELINE, giorno="28/02/2024")
#[{'idAlunno': '####', 'today': [{'id': '####', 'type': 'L', 'data': '28/02/2024', 'subType': '', 'ora': '', 'oralez': '2-3', 'desc': {'title': '', 'subtitle': 'SCIENZE NATURALI', 'notes': 'interrogazioni'}}, ...], 'totali': {'assenze_da_giust': '0', 'assenze_totali': '18', 'ritardi_da_giust': '0', 'ritardi_totali': '6', 'uscite_da_giust': '0', 'uscite_totali': '9'}, 'media_a': '8,51'}]
```
## Docs
Work in progress.
Raw data
{
"_id": null,
"home_page": "https://github.com/Invy55/AxiosStAPI",
"name": "AxiosStAPI",
"maintainer": null,
"docs_url": null,
"requires_python": null,
"maintainer_email": null,
"keywords": "python, axios, axios ita, axios italia, registro, elettronico, registro elettronico, api, wrapper, axios api",
"author": "Invy55 (Marco)",
"author_email": "<marco@invy55.win>",
"download_url": "https://files.pythonhosted.org/packages/09/13/1217b925108e0d46d743c27e843de6f9bd0fef7ea863185c673a026e5c0d/AxiosStAPI-0.0.1.tar.gz",
"platform": null,
"description": "\r\n# AxiosStAPI\r\r\nWrapper in python per usufruire delle API di RE studenti di Axios Italia\r\r\n\r\r\n## Getting started\r\r\n\r\r\n### Logging in\r\r\n\r\r\n```python\r\r\nfrom AxiosStAPI.AxiosStAPI import AxiosStAPI\r\r\napi = AxiosStAPI()\r\r\napi.login(SCUOLA, USER, PASSWORD)\r\r\n```\r\r\n\r\r\n### Retrieving informations:\r\r\n\r\r\n#### Senza Login\r\r\n\r\r\n```python\r\r\n# Ricerca delle scuole con una stringa che pu\u00f2 essere nome, cap, via, ecc\r\r\napi.retrieveAPPCustomerInformationByString(services.RetrieveAPPCustomerInformationByString.SSEARCH, query=\"20090\")\r\r\n#[{'fsIntitolazione': 'MICROTECH', 'fsNome': 'SRL', 'fsCF': '06830500960', 'fsCap': '20090', 'fsRegione': 'LOMBARDIA', 'fsCitta': 'BUCCINASCO', 'fsProvincia': 'MI'}, ...]\r\r\n```\r\r\n\r\r\n#### Con Login\r\r\nPer la lista di tutti i servizi disponibili consulta [services.py](https://github.com/Invy55/AxiosStAPI/blob/main/AxiosStAPI/utils/services.py) e controlla l'implementazione in [AxiosStAPI.py](https://github.com/Invy55/AxiosStAPI/blob/main/AxiosStAPI/AxiosStAPI.py#L115-L130)\r\r\n```python\r\r\n# Ottieni avvenimenti di una giornata\r\r\napi.retrieveDataInformation(services.RetrieveDataInformation.TIMELINE, giorno=\"28/02/2024\")\r\r\n#[{'idAlunno': '####', 'today': [{'id': '####', 'type': 'L', 'data': '28/02/2024', 'subType': '', 'ora': '', 'oralez': '2-3', 'desc': {'title': '', 'subtitle': 'SCIENZE NATURALI', 'notes': 'interrogazioni'}}, ...], 'totali': {'assenze_da_giust': '0', 'assenze_totali': '18', 'ritardi_da_giust': '0', 'ritardi_totali': '6', 'uscite_da_giust': '0', 'uscite_totali': '9'}, 'media_a': '8,51'}]\r\r\n```\r\r\n\r\r\n## Docs\r\r\nWork in progress.\r\n",
"bugtrack_url": null,
"license": null,
"summary": "Wrapper in python per usufruire delle API di RE studenti di Axios Italia",
"version": "0.0.1",
"project_urls": {
"Homepage": "https://github.com/Invy55/AxiosStAPI"
},
"split_keywords": [
"python",
" axios",
" axios ita",
" axios italia",
" registro",
" elettronico",
" registro elettronico",
" api",
" wrapper",
" axios api"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "09131217b925108e0d46d743c27e843de6f9bd0fef7ea863185c673a026e5c0d",
"md5": "c2d26c7706dda6277e7438c022d87523",
"sha256": "2fc33cb0de314e501253792e7e5e19dc4b5d5df767d17ac545054d44bc64b1e1"
},
"downloads": -1,
"filename": "AxiosStAPI-0.0.1.tar.gz",
"has_sig": false,
"md5_digest": "c2d26c7706dda6277e7438c022d87523",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 19580,
"upload_time": "2024-06-07T11:45:17",
"upload_time_iso_8601": "2024-06-07T11:45:17.678235Z",
"url": "https://files.pythonhosted.org/packages/09/13/1217b925108e0d46d743c27e843de6f9bd0fef7ea863185c673a026e5c0d/AxiosStAPI-0.0.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-06-07 11:45:17",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "Invy55",
"github_project": "AxiosStAPI",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"requirements": [],
"lcname": "axiosstapi"
}
JSON
