| Name | PyPwnCollege JSON |
| Version |
0.1.6
JSON |
| download |
| home_page | https://pypwncollege.readthedocs.io/ |
| Summary | A wrapper for the pwn.college API. This allows automating interactions with pwn.college and also includes a command-line-interface(CLI) to list dojos/modules, submit flags, start challenges, run commands in challenge containers and more. |
| upload_time | 2024-02-11 14:29:33 |
| maintainer | |
| docs_url | None |
| author | Zeeshan Ayub |
| requires_python | >=3.8,<4.0 |
| license | |
| keywords |
pwn.college
pwncollege
automation
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# PyPwnCollege
[](https://github.com/zeeshan12340/pypwncollege/actions/workflows/tests.yml)
[](https://codecov.io/gh/zeeshan12340/pypwncollege)
[](https://pypwncollege.readthedocs.io/en/latest/?badge=latest)
[](https://badge.fury.io/py/PyPwnCollege)
PyPwnCollege is an unofficial Python library to interact with the pwn.college API and website.
## Install
```bash
pip install pypwncollege
```
## Demo
```py
from pwncollege import PWNClient
# Create an API connection
client = PWNClient(email="user@example.com", password="S3cr3tP455w0rd!")
# Print the User associated with the client
print(client.user)
```
## CLI
The library also comes with a CLI to interact with the API which is a work in progress. It is included in the published pip package and should be available in shell.
Basic usage:
```bash
pwncli --help
pwncli login -u test1337 -p test1337
pwncli get --dojos
pwncli challenge -d fundamentals -m program-misuse -c level-1 -f flag{test}
```
## Documentation
The documentation is available [here](https://pypwncollege.readthedocs.io/en/latest/).
## Current Features
- Logging into the API
- Fetching Dojos, Modules, Challenges
- Starting a Challenge
- Running an ssh command on a challenge
- Submitting flags
- Getting User details
- Getting rankings in dojos and modules
- Getting information about belted users
## Contributing
If you find a bug or want to add a feature, feel free to open an issue or a pull request.
Raw data
{
"_id": null,
"home_page": "https://pypwncollege.readthedocs.io/",
"name": "PyPwnCollege",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.8,<4.0",
"maintainer_email": "",
"keywords": "pwn.college,pwncollege,automation",
"author": "Zeeshan Ayub",
"author_email": "mayub9799@gmail.com",
"download_url": "https://files.pythonhosted.org/packages/29/03/c66a22402549b5ce409a841cfc4508071c3663cd6a9d948e85c2291d0a04/pypwncollege-0.1.6.tar.gz",
"platform": null,
"description": "# PyPwnCollege\n\n[](https://github.com/zeeshan12340/pypwncollege/actions/workflows/tests.yml)\n[](https://codecov.io/gh/zeeshan12340/pypwncollege)\n[](https://pypwncollege.readthedocs.io/en/latest/?badge=latest)\n[](https://badge.fury.io/py/PyPwnCollege)\n\nPyPwnCollege is an unofficial Python library to interact with the pwn.college API and website.\n\n## Install\n\n```bash\npip install pypwncollege\n```\n\n## Demo\n\n```py\nfrom pwncollege import PWNClient\n# Create an API connection\nclient = PWNClient(email=\"user@example.com\", password=\"S3cr3tP455w0rd!\")\n# Print the User associated with the client\nprint(client.user)\n```\n\n## CLI\n\nThe library also comes with a CLI to interact with the API which is a work in progress. It is included in the published pip package and should be available in shell.\n\nBasic usage:\n\n```bash\npwncli --help\npwncli login -u test1337 -p test1337\npwncli get --dojos\npwncli challenge -d fundamentals -m program-misuse -c level-1 -f flag{test}\n```\n\n## Documentation\n\nThe documentation is available [here](https://pypwncollege.readthedocs.io/en/latest/).\n\n## Current Features\n\n- Logging into the API\n- Fetching Dojos, Modules, Challenges\n - Starting a Challenge\n - Running an ssh command on a challenge\n - Submitting flags\n- Getting User details\n- Getting rankings in dojos and modules\n- Getting information about belted users\n\n## Contributing\n\nIf you find a bug or want to add a feature, feel free to open an issue or a pull request.\n",
"bugtrack_url": null,
"license": "",
"summary": "A wrapper for the pwn.college API. This allows automating interactions with pwn.college and also includes a command-line-interface(CLI) to list dojos/modules, submit flags, start challenges, run commands in challenge containers and more.",
"version": "0.1.6",
"project_urls": {
"Documentation": "https://pypwncollege.readthedocs.io/",
"Homepage": "https://pypwncollege.readthedocs.io/",
"Repository": "https://github.com/zeeshan12340/pypwncollege"
},
"split_keywords": [
"pwn.college",
"pwncollege",
"automation"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "849839106cbdf764d8c509a29b398945950fae898e3ce8bf3281e253c8ee467c",
"md5": "1cba068feb83dae07a8c7d559aca97bb",
"sha256": "715b39378d31a277cca7da18711cf53fe8cb00a136e5bebcdabaee6ec7eadf6a"
},
"downloads": -1,
"filename": "pypwncollege-0.1.6-py3-none-any.whl",
"has_sig": false,
"md5_digest": "1cba068feb83dae07a8c7d559aca97bb",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.8,<4.0",
"size": 17462,
"upload_time": "2024-02-11T14:29:31",
"upload_time_iso_8601": "2024-02-11T14:29:31.015172Z",
"url": "https://files.pythonhosted.org/packages/84/98/39106cbdf764d8c509a29b398945950fae898e3ce8bf3281e253c8ee467c/pypwncollege-0.1.6-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "2903c66a22402549b5ce409a841cfc4508071c3663cd6a9d948e85c2291d0a04",
"md5": "79124fa2997b6879ab3b4404b036eb5f",
"sha256": "b2537dc4ee577dd5af9ebe55e8bc138da40934cc76e6b8636c9330529167a139"
},
"downloads": -1,
"filename": "pypwncollege-0.1.6.tar.gz",
"has_sig": false,
"md5_digest": "79124fa2997b6879ab3b4404b036eb5f",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.8,<4.0",
"size": 14324,
"upload_time": "2024-02-11T14:29:33",
"upload_time_iso_8601": "2024-02-11T14:29:33.627543Z",
"url": "https://files.pythonhosted.org/packages/29/03/c66a22402549b5ce409a841cfc4508071c3663cd6a9d948e85c2291d0a04/pypwncollege-0.1.6.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-02-11 14:29:33",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "zeeshan12340",
"github_project": "pypwncollege",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"requirements": [],
"lcname": "pypwncollege"
}
