[![MIT License](https://img.shields.io/badge/License-MIT-green.svg)](https://github.com/Komo4ekoI/RighiDiaryAPI/blob/master/LICENSE/) [![wakatime](https://wakatime.com/badge/user/90c8afe4-47c1-4f14-9423-4474ab0618ae/project/018c3029-0cbb-4c30-a3a6-3eb80dfefcc1.svg)](https://wakatime.com/badge/user/90c8afe4-47c1-4f14-9423-4474ab0618ae/project/018c3029-0cbb-4c30-a3a6-3eb80dfefcc1)
## INFO
This library makes it easy to retrieve data from a Mastercom account for `Liceo Shientifico A. Righi (Cesena)`.
All operations are performed using http requests and data scraping using the `beautifulsoup4` library. I had to use scraping because Mastercom does not have a full API, so some operations can be a bit slow.
Any operations can be performed with a login and password from Mastercom account.
In some cases you may get false data or a library error because I can take into account all possible scenarios of Mastercom. The data from my account was taken into account during development, but the diary has features that I don't have access to.
If you find a bug and are willing to help improve the project, you can [write about it](https://github.com/Komo4ekoI/RighiDiaryAPI/issues).
## Documentation
#### In progress
## Installation
The library is available on PyPi, so you can install it in the standard way:
##### Windows
```bash
pip install RighiDiary
```
##### Ubuntu/macOS
```bash
pip3 install RighiDiary
```
## Example
```Python
from RighiDiary import authorize_user
import asyncio
my_password: str = "CoolPassword"
my_login: int = 123456
async def main():
user = await authorize_user(login=my_login, password=my_password)
print(user.full_name)
print(user.agenda[0])
if __name__ == '__main__':
asyncio.run(main())
```
Raw data
{
"_id": null,
"home_page": "https://github.com/Komo4ekoI/RighiRegisterAPI",
"name": "RighiDiary",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.7",
"maintainer_email": "",
"keywords": "example,pypi,package,righi,righiAPI,register,diary",
"author": "Vadym Teliatnyk",
"author_email": "laivhakin@gmail.com",
"download_url": "https://files.pythonhosted.org/packages/e0/3d/87288e54ef84e790050a185b7e96277fecd520068054f20bfde575c383b0/RighiDiary-1.0.tar.gz",
"platform": null,
"description": "\r\n[![MIT License](https://img.shields.io/badge/License-MIT-green.svg)](https://github.com/Komo4ekoI/RighiDiaryAPI/blob/master/LICENSE/) [![wakatime](https://wakatime.com/badge/user/90c8afe4-47c1-4f14-9423-4474ab0618ae/project/018c3029-0cbb-4c30-a3a6-3eb80dfefcc1.svg)](https://wakatime.com/badge/user/90c8afe4-47c1-4f14-9423-4474ab0618ae/project/018c3029-0cbb-4c30-a3a6-3eb80dfefcc1)\r\n\r\n## INFO\r\n\r\nThis library makes it easy to retrieve data from a Mastercom account for `Liceo Shientifico A. Righi (Cesena)`.\r\n\r\nAll operations are performed using http requests and data scraping using the `beautifulsoup4` library. I had to use scraping because Mastercom does not have a full API, so some operations can be a bit slow.\r\n\r\nAny operations can be performed with a login and password from Mastercom account.\r\n\r\nIn some cases you may get false data or a library error because I can take into account all possible scenarios of Mastercom. The data from my account was taken into account during development, but the diary has features that I don't have access to.\r\n\r\nIf you find a bug and are willing to help improve the project, you can [write about it](https://github.com/Komo4ekoI/RighiDiaryAPI/issues).\r\n## Documentation\r\n\r\n#### In progress\r\n\r\n\r\n## Installation\r\n\r\nThe library is available on PyPi, so you can install it in the standard way:\r\n\r\n##### Windows\r\n```bash\r\n pip install RighiDiary\r\n```\r\n##### Ubuntu/macOS\r\n```bash\r\n pip3 install RighiDiary\r\n```\r\n## Example\r\n\r\n```Python\r\nfrom RighiDiary import authorize_user\r\nimport asyncio\r\n\r\nmy_password: str = \"CoolPassword\"\r\nmy_login: int = 123456\r\n\r\n\r\nasync def main():\r\n user = await authorize_user(login=my_login, password=my_password)\r\n print(user.full_name)\r\n print(user.agenda[0])\r\n\r\nif __name__ == '__main__':\r\n asyncio.run(main())\r\n```\r\n\r\n",
"bugtrack_url": null,
"license": "",
"summary": "Obtaining data from the electronic diary of the lyceum \"Liceo Scientifico A. Righi\"",
"version": "1.0",
"project_urls": {
"Bug Reports": "https://github.com/Komo4ekoI/RighiRegisterAPI/issues",
"Documentation": "https://github.com/Komo4ekoI/RighiRegisterAPI",
"Homepage": "https://github.com/Komo4ekoI/RighiRegisterAPI",
"Source Code": "https://github.com/Komo4ekoI/RighiRegisterAPI"
},
"split_keywords": [
"example",
"pypi",
"package",
"righi",
"righiapi",
"register",
"diary"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "7f768fb594bfbd9e71e964ceaefd6ef42e1003be5f2f9bcc63bb13fd067e147a",
"md5": "82e1080037d073fd3b572f017559f7c2",
"sha256": "7ac443b73b3324a03c367d590c8a562e8047290fd96033eb140b6171e00dcdf0"
},
"downloads": -1,
"filename": "RighiDiary-1.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "82e1080037d073fd3b572f017559f7c2",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.7",
"size": 18902,
"upload_time": "2023-12-08T18:43:58",
"upload_time_iso_8601": "2023-12-08T18:43:58.640451Z",
"url": "https://files.pythonhosted.org/packages/7f/76/8fb594bfbd9e71e964ceaefd6ef42e1003be5f2f9bcc63bb13fd067e147a/RighiDiary-1.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "e03d87288e54ef84e790050a185b7e96277fecd520068054f20bfde575c383b0",
"md5": "178d28853f1fea7955c635b79f4e2a00",
"sha256": "20720835664e4a66545fe5ea7bfcd327c79e40f852b6902242a18f7c4467b799"
},
"downloads": -1,
"filename": "RighiDiary-1.0.tar.gz",
"has_sig": false,
"md5_digest": "178d28853f1fea7955c635b79f4e2a00",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.7",
"size": 14027,
"upload_time": "2023-12-08T18:44:00",
"upload_time_iso_8601": "2023-12-08T18:44:00.586480Z",
"url": "https://files.pythonhosted.org/packages/e0/3d/87288e54ef84e790050a185b7e96277fecd520068054f20bfde575c383b0/RighiDiary-1.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-12-08 18:44:00",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "Komo4ekoI",
"github_project": "RighiRegisterAPI",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"requirements": [],
"lcname": "righidiary"
}