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.4.tar.gz (17.6 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

PyHackTheBox-0.5.4-py3-none-any.whl (23.4 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: PyHackTheBox-0.5.4.tar.gz
  • Upload date:
  • Size: 17.6 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.11.1 keyring/23.5.0 rfc3986/2.0.0 colorama/0.4.4 CPython/3.8.12

File hashes

Hashes for PyHackTheBox-0.5.4.tar.gz
Algorithm Hash digest
SHA256 f43ec83a94b4d4c9a038a023f75f04e79ec1fe73236daf4dee23423e76ceaf27
MD5 ce7a3678dd6011871d32360513809f10
BLAKE2b-256 83a20a7b171823b1088f8f95a274df302890523293ea67a1dbc2d3ca3c6b4014

See more details on using hashes here.

File details

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

File metadata

  • Download URL: PyHackTheBox-0.5.4-py3-none-any.whl
  • Upload date:
  • Size: 23.4 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.11.1 keyring/23.5.0 rfc3986/2.0.0 colorama/0.4.4 CPython/3.8.12

File hashes

Hashes for PyHackTheBox-0.5.4-py3-none-any.whl
Algorithm Hash digest
SHA256 f0a40d06645d54f17afd6f4622e9c749e08c3f0f00303765d386153dcd1fcef0
MD5 4d3d558d113debc4c060be4f7d056de1
BLAKE2b-256 39b2623ef70071e5251e14a595c526c29a602663eeb70620789ac06cb7f7c64e

See more details on using hashes here.

Supported by

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