edupage-api


Nameedupage-api JSON
Version 0.12.2 PyPI version JSON
download
home_pagehttps://github.com/EdupageAPI/edupage-api
SummaryA Python library for accessing your EduPage account
upload_time2025-10-23 19:33:06
maintainerNone
docs_urlNone
authorivanhrabcak
requires_python>=3.9
licenseNone
keywords edupage edupage api library
VCS
bugtrack_url
requirements requests datetime requests colorama
Travis-CI No Travis.
coveralls test coverage No coveralls.
            # `edupage-api` · [![Current version on PyPI](https://img.shields.io/pypi/v/edupage-api)](https://pypi.org/project/edupage-api/) [![Supported Python versions](https://img.shields.io/pypi/pyversions/edupage-api)](https://pypi.org/project/edupage-api/) [![PyPI - Downloads](https://img.shields.io/pypi/dw/edupage-api)](https://pypistats.org/packages/edupage-api) [![CodeFactor](https://www.codefactor.io/repository/github/EdupageAPI/edupage-api/badge)](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/a3/e3/1ea5fb73a51505faaa00d0b620598ca0c27f6eb22fb809776591c482150c/edupage_api-0.12.2.tar.gz",
    "platform": null,
    "description": "# `edupage-api` · [![Current version on PyPI](https://img.shields.io/pypi/v/edupage-api)](https://pypi.org/project/edupage-api/) [![Supported Python versions](https://img.shields.io/pypi/pyversions/edupage-api)](https://pypi.org/project/edupage-api/) [![PyPI - Downloads](https://img.shields.io/pypi/dw/edupage-api)](https://pypistats.org/packages/edupage-api) [![CodeFactor](https://www.codefactor.io/repository/github/EdupageAPI/edupage-api/badge)](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.2",
    "project_urls": {
        "Homepage": "https://github.com/EdupageAPI/edupage-api"
    },
    "split_keywords": [
        "edupage",
        " edupage api",
        " library"
    ],
    "urls": [
        {
            "comment_text": null,
            "digests": {
                "blake2b_256": "6a2e5e82680403c1c91fb24ee0fe3b2ce06302dc9cf15266fcd00b40d48f6a7d",
                "md5": "2e246ead9b07f99a0eae8f08be6b18a0",
                "sha256": "13994136b92c60ef203e5281176d8df77868ac0f2d9f588626f9189133a8399a"
            },
            "downloads": -1,
            "filename": "edupage_api-0.12.2-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "2e246ead9b07f99a0eae8f08be6b18a0",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">=3.9",
            "size": 44595,
            "upload_time": "2025-10-23T19:33:05",
            "upload_time_iso_8601": "2025-10-23T19:33:05.470600Z",
            "url": "https://files.pythonhosted.org/packages/6a/2e/5e82680403c1c91fb24ee0fe3b2ce06302dc9cf15266fcd00b40d48f6a7d/edupage_api-0.12.2-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": null,
            "digests": {
                "blake2b_256": "a3e31ea5fb73a51505faaa00d0b620598ca0c27f6eb22fb809776591c482150c",
                "md5": "8012f6c675b2656ac1c410260361dec0",
                "sha256": "07ed3f607a733fd1122b532ca1e020272d2b5bcd3303d8ccd90e3521e08cc9b3"
            },
            "downloads": -1,
            "filename": "edupage_api-0.12.2.tar.gz",
            "has_sig": false,
            "md5_digest": "8012f6c675b2656ac1c410260361dec0",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.9",
            "size": 38038,
            "upload_time": "2025-10-23T19:33:06",
            "upload_time_iso_8601": "2025-10-23T19:33:06.726528Z",
            "url": "https://files.pythonhosted.org/packages/a3/e3/1ea5fb73a51505faaa00d0b620598ca0c27f6eb22fb809776591c482150c/edupage_api-0.12.2.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2025-10-23 19:33:06",
    "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"
}
        
Elapsed time: 4.41585s