# `edupage-api` · [](https://pypi.org/project/edupage-api/) [](https://pypi.org/project/edupage-api/) [](https://pypistats.org/packages/edupage-api) [](https://www.codefactor.io/repository/github/EdupageAPI/edupage-api)
This Python library allows easy access to EduPage. It's not a Selenium web scraper. It makes requests directly to EduPage's endpoints and parses the HTML document.
# Installing
__Warning__: Requires Python >= 3.9!
You can install this library using [`pip`](https://pypi.org/project/pip/):
```
pip install edupage-api
```
# Usage
## Login
You can log in easily, it works with any school:
```python
from edupage_api import Edupage
from edupage_api.exceptions import BadCredentialsException, CaptchaException
edupage = Edupage()
try:
edupage.login("Username", "Password", "Your school's subdomain")
except BadCredentialsException:
print("Wrong username or password!")
except CaptchaException:
print("Captcha required!")
```
# Documentation
The docs are available [here](https://edupageapi.github.io/edupage-api/)
# I have a problem or an idea!
- If you find any issue with this code, or it doesn't work please, let us know by opening an [issue](https://github.com/EdupageAPI/edupage-api/issues/new/choose)!
- Feel free to suggest any other features! Just open an [issue with the _Feature Request_ tag](https://github.com/EdupageAPI/edupage-api/issues/new?labels=feature+request&template=feature_request.md&title=%5BFeature+request%5D+).
- If you, even better, have fixed the issue, added a new feature, or made something work better, please, open a [pull request](https://github.com/EdupageAPI/edupage-api/compare)!
# Discord
https://discord.gg/fg6zBu9ZAn
Raw data
{
"_id": null,
"home_page": "https://github.com/EdupageAPI/edupage-api",
"name": "edupage-api",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.9",
"maintainer_email": null,
"keywords": "edupage, edupage api, library",
"author": "ivanhrabcak",
"author_email": "ivan@hrabcak.eu",
"download_url": "https://files.pythonhosted.org/packages/73/4b/ff9663423d024b6d35be48054e3c8df79f00fb3584494ed6cfe785d3f226/edupage_api-0.12.0.tar.gz",
"platform": null,
"description": "# `edupage-api` · [](https://pypi.org/project/edupage-api/) [](https://pypi.org/project/edupage-api/) [](https://pypistats.org/packages/edupage-api) [](https://www.codefactor.io/repository/github/EdupageAPI/edupage-api)\n\nThis Python library allows easy access to EduPage. It's not a Selenium web scraper. It makes requests directly to EduPage's endpoints and parses the HTML document.\n\n# Installing\n__Warning__: Requires Python >= 3.9!\n\nYou can install this library using [`pip`](https://pypi.org/project/pip/):\n\n```\npip install edupage-api\n```\n\n# Usage\n\n## Login\n\nYou can log in easily, it works with any school:\n\n```python\nfrom edupage_api import Edupage\nfrom edupage_api.exceptions import BadCredentialsException, CaptchaException\n\nedupage = Edupage()\n\ntry:\n edupage.login(\"Username\", \"Password\", \"Your school's subdomain\")\nexcept BadCredentialsException:\n print(\"Wrong username or password!\")\nexcept CaptchaException:\n print(\"Captcha required!\")\n```\n\n# Documentation\nThe docs are available [here](https://edupageapi.github.io/edupage-api/)\n\n# I have a problem or an idea!\n\n- If you find any issue with this code, or it doesn't work please, let us know by opening an [issue](https://github.com/EdupageAPI/edupage-api/issues/new/choose)!\n- Feel free to suggest any other features! Just open an [issue with the _Feature Request_ tag](https://github.com/EdupageAPI/edupage-api/issues/new?labels=feature+request&template=feature_request.md&title=%5BFeature+request%5D+).\n- If you, even better, have fixed the issue, added a new feature, or made something work better, please, open a [pull request](https://github.com/EdupageAPI/edupage-api/compare)!\n\n# Discord\nhttps://discord.gg/fg6zBu9ZAn\n",
"bugtrack_url": null,
"license": null,
"summary": "A Python library for accessing your EduPage account",
"version": "0.12.0",
"project_urls": {
"Homepage": "https://github.com/EdupageAPI/edupage-api"
},
"split_keywords": [
"edupage",
" edupage api",
" library"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "328b04aed81ff5311e0fc9b8eca7c6806d51df8c86d24565d1d60e080c1d55ae",
"md5": "5d22d40e9f88ed54d6d641023b7afa06",
"sha256": "2bee81dd0903aa5cfe7d5c3b27518d074b4b7b37a22a71ac2bb4858cff7f9d5a"
},
"downloads": -1,
"filename": "edupage_api-0.12.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "5d22d40e9f88ed54d6d641023b7afa06",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.9",
"size": 43767,
"upload_time": "2025-01-19T23:31:33",
"upload_time_iso_8601": "2025-01-19T23:31:33.094484Z",
"url": "https://files.pythonhosted.org/packages/32/8b/04aed81ff5311e0fc9b8eca7c6806d51df8c86d24565d1d60e080c1d55ae/edupage_api-0.12.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "734bff9663423d024b6d35be48054e3c8df79f00fb3584494ed6cfe785d3f226",
"md5": "5cd33218305b13d510239549d073e9ff",
"sha256": "57b6bb4578b9e54012605520a64a64c3aedb0afe9aea6d478c17131070f58809"
},
"downloads": -1,
"filename": "edupage_api-0.12.0.tar.gz",
"has_sig": false,
"md5_digest": "5cd33218305b13d510239549d073e9ff",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.9",
"size": 37441,
"upload_time": "2025-01-19T23:31:34",
"upload_time_iso_8601": "2025-01-19T23:31:34.894934Z",
"url": "https://files.pythonhosted.org/packages/73/4b/ff9663423d024b6d35be48054e3c8df79f00fb3584494ed6cfe785d3f226/edupage_api-0.12.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2025-01-19 23:31:34",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "EdupageAPI",
"github_project": "edupage-api",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"requirements": [
{
"name": "requests",
"specs": []
},
{
"name": "datetime",
"specs": []
},
{
"name": "requests",
"specs": []
},
{
"name": "colorama",
"specs": []
}
],
"lcname": "edupage-api"
}
JSON
