pesuacademy


Namepesuacademy JSON
Version 1.0.0 PyPI version JSON
download
home_pageNone
SummarySuper-fast and lightweight Python wrapper for PESU Academy.
upload_time2025-08-12 06:20:00
maintainerNone
docs_urlNone
authorNone
requires_python>=3.11
licenseMIT License Copyright (c) 2025 Aditeya Baral Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
keywords pesu pesu academy python client wrapper
VCS
bugtrack_url
requirements annotated-types anyio beautifulsoup4 certifi h11 httpcore httpx idna pydantic pydantic-core python-dotenv selectolax sniffio soupsieve typing-extensions typing-inspection
Travis-CI No Travis.
coveralls test coverage No coveralls.
            # pesuacademy-py

![PyPI](https://img.shields.io/pypi/v/pesuacademy?label=pypi%20package)
![GitHub Release](https://img.shields.io/github/v/release/HackerSpace-PESU/pesuacademy-py)
![GitHub Tag](https://img.shields.io/github/v/tag/HackerSpace-PESU/pesuacademy-py)
![PyPI - Status](https://img.shields.io/pypi/status/pesuacademy)
![PyPI - Python Version](https://img.shields.io/pypi/pyversions/pesuacademy)

![GitHub commit activity](https://img.shields.io/github/commit-activity/w/HackerSpace-PESU/pesuacademy-py)
![GitHub last commit](https://img.shields.io/github/last-commit/HackerSpace-PESU/pesuacademy-py)
![GitHub commits since latest release](https://img.shields.io/github/commits-since/HackerSpace-PESU/pesuacademy-py/latest)

![black.yml](https://github.com/HackerSpace-PESU/pesuacademy-py/actions/workflows/black.yml/badge.svg)
![python-package-pip.yml](https://github.com/HackerSpace-PESU/pesuacademy-py/actions/workflows/python-package-pip.yml/badge.svg)
![python-publish.yml](https://github.com/HackerSpace-PESU/pesuacademy-py/actions/workflows/python-publish.yml/badge.svg)
![build-docs.yml](https://github.com/HackerSpace-PESU/pesuacademy-py/actions/workflows/build-docs.yml/badge.svg)

Python wrapper and APIs for the PESU Academy website.

The wrapper provides **read-only** access to all the pages and information accessible on the PESU Academy website.
Without authentication, the wrapper will only be able to fetch details from the `Know Your Class and Section` page.

> :warning: **Warning:** This is not an official API and is not endorsed by PES University. Use at your own risk.

## Installation

### Installing from `pip`

```bash
pip install pesuacademy
```

### Installing from source

```bash
git clone https://github.com/HackerSpace-PESU/pesuacademy-py
cd pesuacademy-py
python setup.py install
```

## Usage

```python
from pesuacademy import PESUAcademy

p = PESUAcademy("PRN_or_SRN", "password")
# p = PESUAcademy() # Without authentication: can only fetch details from the `Know Your Class and Section` page
profile = p.profile()
courses = p.courses(semester=2)
attendance = p.attendance()
```

            

Raw data

            {
    "_id": null,
    "home_page": null,
    "name": "pesuacademy",
    "maintainer": null,
    "docs_url": null,
    "requires_python": ">=3.11",
    "maintainer_email": null,
    "keywords": "pesu, pesu academy, python client, wrapper",
    "author": null,
    "author_email": "Aditeya Baral <aditeya.baral@gmail.com>, Samarth Mohan <samarth.lina@gmail.com>",
    "download_url": "https://files.pythonhosted.org/packages/ab/34/f916e0a9b45aba7ddf32706571312a9538e72907db8076add07a328896ac/pesuacademy-1.0.0.tar.gz",
    "platform": null,
    "description": "# pesuacademy-py\n\n![PyPI](https://img.shields.io/pypi/v/pesuacademy?label=pypi%20package)\n![GitHub Release](https://img.shields.io/github/v/release/HackerSpace-PESU/pesuacademy-py)\n![GitHub Tag](https://img.shields.io/github/v/tag/HackerSpace-PESU/pesuacademy-py)\n![PyPI - Status](https://img.shields.io/pypi/status/pesuacademy)\n![PyPI - Python Version](https://img.shields.io/pypi/pyversions/pesuacademy)\n\n![GitHub commit activity](https://img.shields.io/github/commit-activity/w/HackerSpace-PESU/pesuacademy-py)\n![GitHub last commit](https://img.shields.io/github/last-commit/HackerSpace-PESU/pesuacademy-py)\n![GitHub commits since latest release](https://img.shields.io/github/commits-since/HackerSpace-PESU/pesuacademy-py/latest)\n\n![black.yml](https://github.com/HackerSpace-PESU/pesuacademy-py/actions/workflows/black.yml/badge.svg)\n![python-package-pip.yml](https://github.com/HackerSpace-PESU/pesuacademy-py/actions/workflows/python-package-pip.yml/badge.svg)\n![python-publish.yml](https://github.com/HackerSpace-PESU/pesuacademy-py/actions/workflows/python-publish.yml/badge.svg)\n![build-docs.yml](https://github.com/HackerSpace-PESU/pesuacademy-py/actions/workflows/build-docs.yml/badge.svg)\n\nPython wrapper and APIs for the PESU Academy website.\n\nThe wrapper provides **read-only** access to all the pages and information accessible on the PESU Academy website.\nWithout authentication, the wrapper will only be able to fetch details from the `Know Your Class and Section` page.\n\n> :warning: **Warning:** This is not an official API and is not endorsed by PES University. Use at your own risk.\n\n## Installation\n\n### Installing from `pip`\n\n```bash\npip install pesuacademy\n```\n\n### Installing from source\n\n```bash\ngit clone https://github.com/HackerSpace-PESU/pesuacademy-py\ncd pesuacademy-py\npython setup.py install\n```\n\n## Usage\n\n```python\nfrom pesuacademy import PESUAcademy\n\np = PESUAcademy(\"PRN_or_SRN\", \"password\")\n# p = PESUAcademy() # Without authentication: can only fetch details from the `Know Your Class and Section` page\nprofile = p.profile()\ncourses = p.courses(semester=2)\nattendance = p.attendance()\n```\n",
    "bugtrack_url": null,
    "license": "MIT License\n        \n        Copyright (c) 2025 Aditeya Baral\n        \n        Permission is hereby granted, free of charge, to any person obtaining a copy\n        of this software and associated documentation files (the \"Software\"), to deal\n        in the Software without restriction, including without limitation the rights\n        to use, copy, modify, merge, publish, distribute, sublicense, and/or sell\n        copies of the Software, and to permit persons to whom the Software is\n        furnished to do so, subject to the following conditions:\n        \n        The above copyright notice and this permission notice shall be included in all\n        copies or substantial portions of the Software.\n        \n        THE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR\n        IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,\n        FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE\n        AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER\n        LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,\n        OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE\n        SOFTWARE.",
    "summary": "Super-fast and lightweight Python wrapper for PESU Academy.",
    "version": "1.0.0",
    "project_urls": {
        "BugTracker": "https://github.com/pesu-dev/pesuacademy/issues",
        "Documentation": "https://github.com/pesu-dev/pesuacademy#readme",
        "Homepage": "https://github.com/pesu-dev/pesuacademy",
        "Repository": "https://github.com/pesu-dev/pesuacademy"
    },
    "split_keywords": [
        "pesu",
        " pesu academy",
        " python client",
        " wrapper"
    ],
    "urls": [
        {
            "comment_text": null,
            "digests": {
                "blake2b_256": "a4ece5f4755b46a882649e04afe44c627572762999c72cd93ad2d21556bc2dc3",
                "md5": "4d5393eb14ac71d10df8081fc41593d1",
                "sha256": "b5e1c6d092d704d3f333c7f5e7242d99413d20e369cb56235a29a35855805eba"
            },
            "downloads": -1,
            "filename": "pesuacademy-1.0.0-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "4d5393eb14ac71d10df8081fc41593d1",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">=3.11",
            "size": 28137,
            "upload_time": "2025-08-12T06:19:59",
            "upload_time_iso_8601": "2025-08-12T06:19:59.401699Z",
            "url": "https://files.pythonhosted.org/packages/a4/ec/e5f4755b46a882649e04afe44c627572762999c72cd93ad2d21556bc2dc3/pesuacademy-1.0.0-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": null,
            "digests": {
                "blake2b_256": "ab34f916e0a9b45aba7ddf32706571312a9538e72907db8076add07a328896ac",
                "md5": "5faf7b798d1e8ae7a22a2467979b60ec",
                "sha256": "3849b958c51e6b9b75566c232f19351c270d6bdae02b3cfd0d5e3b5c96d64614"
            },
            "downloads": -1,
            "filename": "pesuacademy-1.0.0.tar.gz",
            "has_sig": false,
            "md5_digest": "5faf7b798d1e8ae7a22a2467979b60ec",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.11",
            "size": 76533,
            "upload_time": "2025-08-12T06:20:00",
            "upload_time_iso_8601": "2025-08-12T06:20:00.527353Z",
            "url": "https://files.pythonhosted.org/packages/ab/34/f916e0a9b45aba7ddf32706571312a9538e72907db8076add07a328896ac/pesuacademy-1.0.0.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2025-08-12 06:20:00",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "pesu-dev",
    "github_project": "pesuacademy",
    "travis_ci": false,
    "coveralls": false,
    "github_actions": true,
    "requirements": [
        {
            "name": "annotated-types",
            "specs": [
                [
                    "==",
                    "0.7.0"
                ]
            ]
        },
        {
            "name": "anyio",
            "specs": [
                [
                    "==",
                    "4.10.0"
                ]
            ]
        },
        {
            "name": "beautifulsoup4",
            "specs": [
                [
                    "==",
                    "4.13.4"
                ]
            ]
        },
        {
            "name": "certifi",
            "specs": [
                [
                    "==",
                    "2025.8.3"
                ]
            ]
        },
        {
            "name": "h11",
            "specs": [
                [
                    "==",
                    "0.16.0"
                ]
            ]
        },
        {
            "name": "httpcore",
            "specs": [
                [
                    "==",
                    "1.0.9"
                ]
            ]
        },
        {
            "name": "httpx",
            "specs": [
                [
                    "==",
                    "0.28.1"
                ]
            ]
        },
        {
            "name": "idna",
            "specs": [
                [
                    "==",
                    "3.10"
                ]
            ]
        },
        {
            "name": "pydantic",
            "specs": [
                [
                    "==",
                    "2.11.7"
                ]
            ]
        },
        {
            "name": "pydantic-core",
            "specs": [
                [
                    "==",
                    "2.33.2"
                ]
            ]
        },
        {
            "name": "python-dotenv",
            "specs": [
                [
                    "==",
                    "1.1.1"
                ]
            ]
        },
        {
            "name": "selectolax",
            "specs": [
                [
                    "==",
                    "0.3.33"
                ]
            ]
        },
        {
            "name": "sniffio",
            "specs": [
                [
                    "==",
                    "1.3.1"
                ]
            ]
        },
        {
            "name": "soupsieve",
            "specs": [
                [
                    "==",
                    "2.7"
                ]
            ]
        },
        {
            "name": "typing-extensions",
            "specs": [
                [
                    "==",
                    "4.14.1"
                ]
            ]
        },
        {
            "name": "typing-inspection",
            "specs": [
                [
                    "==",
                    "0.4.1"
                ]
            ]
        }
    ],
    "lcname": "pesuacademy"
}
        
Elapsed time: 0.72663s