Zeeshan12340 / pypwncollege

PyPwnCollege is an unofficial Python library to interact with the pwn.college API and website.

Home Page:https://pypwncollege.readthedocs.io/en/latest/

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

PyPwnCollege

Run Tests codecov Documentation Status PyPI version PyPI Statistics

PyPwnCollege is an unofficial Python library to interact with the pwn.college API and website.

Install

pip install pypwncollege

Demo

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:

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.

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.

About

PyPwnCollege is an unofficial Python library to interact with the pwn.college API and website.

https://pypwncollege.readthedocs.io/en/latest/

License:MIT License


Languages

Language:Python 100.0%