Skip to main content

A wrapper for the Hack The Box API.

Project description

PyHackTheBox

Run Tests codecov Documentation Status PyPI version

PyHackTheBox is an unofficial Python library to interact with the Hack The Box API.

Install

$ pip install pyhackthebox

Demo

from hackthebox import HTBClient
# Create an API connection
client = HTBClient(email="user@example.com", password="S3cr3tP455w0rd!")
# Print the User associated with the client
print(client.user)

Documentation

The documentation is available here.

Current Features

  • Logging into the API (and automatically refreshing access tokens)
  • Challenges, Machines, Fortresses and Endgames
    • Getting details
    • Viewing authors
    • Viewing first bloods
    • Submitting flags
  • Searching Users, Challenges, Machines and Teams
  • Spawning and stopping Challenge instances
  • Retrieving user activity
  • Viewing Hall(s) of Fame (Top 100, VIP, Team and University Leaderboards)

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

PyHackTheBox-0.4.2.tar.gz (15.5 kB view details)

Uploaded Source

Built Distribution

PyHackTheBox-0.4.2-py3-none-any.whl (20.8 kB view details)

Uploaded Python 3

File details

Details for the file PyHackTheBox-0.4.2.tar.gz.

File metadata

  • Download URL: PyHackTheBox-0.4.2.tar.gz
  • Upload date:
  • Size: 15.5 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.4.2 importlib_metadata/4.8.1 pkginfo/1.7.1 requests/2.26.0 requests-toolbelt/0.9.1 tqdm/4.62.3 CPython/3.8.12

File hashes

Hashes for PyHackTheBox-0.4.2.tar.gz
Algorithm Hash digest
SHA256 e3d99cae807bd11d380d058ab744769ce509d81d4fbef75579a563464e15322e
MD5 3e6ea3f53f3fbefa6514d5ae29dff4ed
BLAKE2b-256 52594a7acae136abb9ef360d16942ad1cb08ad62af1a78b76a5651f715b8b00a

See more details on using hashes here.

File details

Details for the file PyHackTheBox-0.4.2-py3-none-any.whl.

File metadata

  • Download URL: PyHackTheBox-0.4.2-py3-none-any.whl
  • Upload date:
  • Size: 20.8 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.4.2 importlib_metadata/4.8.1 pkginfo/1.7.1 requests/2.26.0 requests-toolbelt/0.9.1 tqdm/4.62.3 CPython/3.8.12

File hashes

Hashes for PyHackTheBox-0.4.2-py3-none-any.whl
Algorithm Hash digest
SHA256 7f069639949b6ccb2a0d50aba06f21bcd07e87e49ab0b78a54143a0dbddb39cc
MD5 e06132dd2c09a34c3f798f415a937101
BLAKE2b-256 63e06408cb32b3362ff14e454d92c06f2f509bc032e8f22a7fb5113bde5c8715

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page