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.5.6.post1.tar.gz (19.3 kB view details)

Uploaded Source

Built Distribution

PyHackTheBox-0.5.6.post1-py3-none-any.whl (25.5 kB view details)

Uploaded Python 3

File details

Details for the file PyHackTheBox-0.5.6.post1.tar.gz.

File metadata

  • Download URL: PyHackTheBox-0.5.6.post1.tar.gz
  • Upload date:
  • Size: 19.3 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.8.0 pkginfo/1.8.2 readme-renderer/32.0 requests/2.27.1 requests-toolbelt/0.9.1 urllib3/1.26.8 tqdm/4.62.3 importlib-metadata/4.8.1 keyring/23.4.0 rfc3986/2.0.0 colorama/0.4.4 CPython/3.10.2

File hashes

Hashes for PyHackTheBox-0.5.6.post1.tar.gz
Algorithm Hash digest
SHA256 0591bbf0871faa691aa506d561dce208c947ea53f95b274a7b34353ba12b7a77
MD5 232e6816241775c90ce6529dbe690143
BLAKE2b-256 efcde20d5ec1e001b0362eb909fd26adfcd9c1578739a3758c4ac963623bf1d7

See more details on using hashes here.

File details

Details for the file PyHackTheBox-0.5.6.post1-py3-none-any.whl.

File metadata

  • Download URL: PyHackTheBox-0.5.6.post1-py3-none-any.whl
  • Upload date:
  • Size: 25.5 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.8.0 pkginfo/1.8.2 readme-renderer/32.0 requests/2.27.1 requests-toolbelt/0.9.1 urllib3/1.26.8 tqdm/4.62.3 importlib-metadata/4.8.1 keyring/23.4.0 rfc3986/2.0.0 colorama/0.4.4 CPython/3.10.2

File hashes

Hashes for PyHackTheBox-0.5.6.post1-py3-none-any.whl
Algorithm Hash digest
SHA256 f061d507a719c32754a514ea795170f22135d811aec1649f51a655d10c3b9430
MD5 1999cf01e8e569f34ea2f773e3f9a897
BLAKE2b-256 fa98e1545d6c761cbafc35a9d7beb880f3ecf98a8d563bd31153367490358db7

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