# Argo Famiglia API
An API wrapper created to interface Python with Argo ScuolaNext.
You can use this library to automate some actions like:
- Check for new announcements;
- Check homework for the next and past days;
- And more...
## How the idea was born
The idea was born because the official app doesn't notify you if an announcements arrives, or if you receive a new vote, and also because the app is **REALLY** slow.
I then implemented this API in a [Discord bot](https://github.com/salvatore-abello/ArgoDiscordBot "Discord bot") (not working for now) that notifies me and my class about new announcements from the school.
There are other libraries similar to this one, such as the library created by [Hearot](https://github.com/hearot/ArgoScuolaNext), but it doesn't work anymore. For now this is the only working library.
### How to use
You can install this library with:
`python3 -m pip install -U git+https://github.com/salvatore-abello/argofamiglia.git`
You can also install this from the Python Package Index with:
`python3 -m pip install argofamiglia`
Here's an example of how to obtain a dict containing the homework.
The keys of the dict will be equal to the due dates of the homework.
```
from argofamiglia import ArgoFamiglia
session = ArgoFamiglia("SCHOOL_CODE", "myusername", "mypassword")
print(session.getCompitiByDate())
# prints:
# {'2022-09-22': {'compiti': ['compiti materia 1',
# 'compiti materia 2',
# 'compiti materia 3'],
# 'materie': ['MATERIA 1',
# 'MATERIA 2',
# 'MATERIA 3']
# }, ...
```
---
# Disclaimer
This library is not finished, some methods aren't working in the file called `auth.py`
Raw data
{
"_id": null,
"home_page": "https://github.com/salvatore-abello/argofamiglia",
"name": "argofamiglia",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.8",
"maintainer_email": "",
"keywords": "argofamiglia argo argoscuolanext python scuolanext",
"author": "Salvatore Abello",
"author_email": "salvatore.abello2005@gmail.com",
"download_url": "https://files.pythonhosted.org/packages/22/7d/f5be11122e005ee12d72c06b500f5cead1941aa28fa05cf6fadf502f628f/argofamiglia-0.1.2.tar.gz",
"platform": null,
"description": "# Argo Famiglia API\nAn API wrapper created to interface Python with Argo ScuolaNext.\nYou can use this library to automate some actions like:\n- Check for new announcements;\n- Check homework for the next and past days;\n- And more...\n\n## How the idea was born\nThe idea was born because the official app doesn't notify you if an announcements arrives, or if you receive a new vote, and also because the app is **REALLY** slow.\nI then implemented this API in a [Discord bot](https://github.com/salvatore-abello/ArgoDiscordBot \"Discord bot\") (not working for now) that notifies me and my class about new announcements from the school.\n\nThere are other libraries similar to this one, such as the library created by [Hearot](https://github.com/hearot/ArgoScuolaNext), but it doesn't work anymore. For now this is the only working library.\n\n### How to use\nYou can install this library with:\n`python3 -m pip install -U git+https://github.com/salvatore-abello/argofamiglia.git`\n\nYou can also install this from the Python Package Index with:\n`python3 -m pip install argofamiglia`\n\n\nHere's an example of how to obtain a dict containing the homework.\nThe keys of the dict will be equal to the due dates of the homework.\n```\nfrom argofamiglia import ArgoFamiglia\n\nsession = ArgoFamiglia(\"SCHOOL_CODE\", \"myusername\", \"mypassword\")\nprint(session.getCompitiByDate())\n# prints:\n# {'2022-09-22': {'compiti': ['compiti materia 1',\n# 'compiti materia 2',\n# 'compiti materia 3'],\n# 'materie': ['MATERIA 1',\n# 'MATERIA 2',\n# 'MATERIA 3']\n# }, ...\n```\n---\n# Disclaimer\nThis library is not finished, some methods aren't working in the file called `auth.py`\n",
"bugtrack_url": null,
"license": "",
"summary": "An API wrapper created to interface Python with Argo ScuolaNext.",
"version": "0.1.2",
"split_keywords": [
"argofamiglia",
"argo",
"argoscuolanext",
"python",
"scuolanext"
],
"urls": [
{
"comment_text": "",
"digests": {
"md5": "6da0b368f50afa138ffac431928f132c",
"sha256": "79f0fe0c352cd023bab116c57ef076910789f89e4d3a5529e77ccc4fc4208f9c"
},
"downloads": -1,
"filename": "argofamiglia-0.1.2-py3-none-any.whl",
"has_sig": false,
"md5_digest": "6da0b368f50afa138ffac431928f132c",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.8",
"size": 6480,
"upload_time": "2022-12-18T21:21:15",
"upload_time_iso_8601": "2022-12-18T21:21:15.280613Z",
"url": "https://files.pythonhosted.org/packages/73/15/bf49d38fb602579e4a18ad0296f21b71fa7cf247c0e6a0f1a267340dbc37/argofamiglia-0.1.2-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"md5": "e462134cb4ebb4e9b3c85f433b1fc3e9",
"sha256": "065af3a04c9dd48e9e9eb965d18675237e4ff8c00e05e14385a6d342427ea601"
},
"downloads": -1,
"filename": "argofamiglia-0.1.2.tar.gz",
"has_sig": false,
"md5_digest": "e462134cb4ebb4e9b3c85f433b1fc3e9",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.8",
"size": 5672,
"upload_time": "2022-12-18T21:21:16",
"upload_time_iso_8601": "2022-12-18T21:21:16.708018Z",
"url": "https://files.pythonhosted.org/packages/22/7d/f5be11122e005ee12d72c06b500f5cead1941aa28fa05cf6fadf502f628f/argofamiglia-0.1.2.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2022-12-18 21:21:16",
"github": true,
"gitlab": false,
"bitbucket": false,
"github_user": "salvatore-abello",
"github_project": "argofamiglia",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"requirements": [
{
"name": "certifi",
"specs": [
[
"==",
"2022.5.18.1"
]
]
},
{
"name": "charset-normalizer",
"specs": [
[
"==",
"2.0.12"
]
]
},
{
"name": "idna",
"specs": [
[
"==",
"3.3"
]
]
},
{
"name": "requests",
"specs": [
[
"==",
"2.27.1"
]
]
},
{
"name": "urllib3",
"specs": [
[
"==",
"1.26.9"
]
]
}
],
"lcname": "argofamiglia"
}
JSON
