edupage-api


Nameedupage-api JSON
Version 0.10.8 PyPI version JSON
download
home_pagehttps://github.com/EdupageAPI/edupage-api
SummaryA python library for accessing your Edupage account
upload_time2024-03-19 09:11:00
maintainer
docs_urlNone
authorivanhrabcak
requires_python>=3.9
license
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

edupage = Edupage()

try:
    edupage.login("Username", "Password", "Your school's subdomain")
except BadCredentialsException:
    print("Wrong username or password!")
except LoginDataParsingException:
    print("Try again or open an issue!")
```

# 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": "",
    "docs_url": null,
    "requires_python": ">=3.9",
    "maintainer_email": "",
    "keywords": "edupage,edupage api,library",
    "author": "ivanhrabcak",
    "author_email": "ivan@hrabcak.eu",
    "download_url": "https://files.pythonhosted.org/packages/7b/9d/99f79af7df11ff8ff2483ca9672ecaa27f4d21aa27316227b7112cfbdf99/edupage_api-0.10.8.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\n\nedupage = Edupage()\n\ntry:\n    edupage.login(\"Username\", \"Password\", \"Your school's subdomain\")\nexcept BadCredentialsException:\n    print(\"Wrong username or password!\")\nexcept LoginDataParsingException:\n    print(\"Try again or open an issue!\")\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": "",
    "summary": "A python library for accessing your Edupage account",
    "version": "0.10.8",
    "project_urls": {
        "Homepage": "https://github.com/EdupageAPI/edupage-api"
    },
    "split_keywords": [
        "edupage",
        "edupage api",
        "library"
    ],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "2a482d2c3583c040885ef002e479e6fdd5ec3848bc05a69471830299a06eb900",
                "md5": "f0d6547f24cb979d17f2da74699b0669",
                "sha256": "2831f3f47efc556f7b8849431517230e57bd28751d697d55b714390a8aa2cb46"
            },
            "downloads": -1,
            "filename": "edupage_api-0.10.8-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "f0d6547f24cb979d17f2da74699b0669",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">=3.9",
            "size": 42478,
            "upload_time": "2024-03-19T09:10:59",
            "upload_time_iso_8601": "2024-03-19T09:10:59.128902Z",
            "url": "https://files.pythonhosted.org/packages/2a/48/2d2c3583c040885ef002e479e6fdd5ec3848bc05a69471830299a06eb900/edupage_api-0.10.8-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "7b9d99f79af7df11ff8ff2483ca9672ecaa27f4d21aa27316227b7112cfbdf99",
                "md5": "63479293130e04d171225ed2a338e3af",
                "sha256": "cb5aab4f33bb4a522979bfecbe3abcff1710af10eec9ae15d04755dbeba9a179"
            },
            "downloads": -1,
            "filename": "edupage_api-0.10.8.tar.gz",
            "has_sig": false,
            "md5_digest": "63479293130e04d171225ed2a338e3af",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.9",
            "size": 36675,
            "upload_time": "2024-03-19T09:11:00",
            "upload_time_iso_8601": "2024-03-19T09:11:00.703466Z",
            "url": "https://files.pythonhosted.org/packages/7b/9d/99f79af7df11ff8ff2483ca9672ecaa27f4d21aa27316227b7112cfbdf99/edupage_api-0.10.8.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2024-03-19 09:11:00",
    "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: 0.24589s