Skip to main content

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)

Metadata

Release files for PyHackTheBox 0.5.6.post1

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for PyHackTheBox 0.5.6.post1
File Size Uploaded Provenance Actions
PyHackTheBox-0.5.6.post1.tar.gz 19.3 kB Without provenance Details for PyHackTheBox-0.5.6.post1.tar.gz

Built distribution (wheel)

Table of built distributions (wheels) for PyHackTheBox 0.5.6.post1
File Interpreter ABI Platform Actions
PyHackTheBox-0.5.6.post1-py3-none-any.whl Python 3 none any Details for PyHackTheBox-0.5.6.post1-py3-none-any.whl

Total release size: 44.8 kB

Release files / PyHackTheBox-0.5.6.post1.tar.gz

Download URL PyHackTheBox-0.5.6.post1.tar.gz
Size 19.3 kB
Tags Source
SHA-256 checksum
How to use checksums
0591bbf0871faa691aa506d561dce208c947ea53f95b274a7b34353ba12b7a77
BLAKE2b-256 checksum
How to use checksums
efcde20d5ec1e001b0362eb909fd26adfcd9c1578739a3758c4ac963623bf1d7
Upload date
Uploaded using Trusted Publishing?
What is 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

Release files / PyHackTheBox-0.5.6.post1-py3-none-any.whl

Download URL PyHackTheBox-0.5.6.post1-py3-none-any.whl
Size 25.5 kB
Tags Python 3
SHA-256 checksum
How to use checksums
f061d507a719c32754a514ea795170f22135d811aec1649f51a655d10c3b9430
BLAKE2b-256 checksum
How to use checksums
fa98e1545d6c761cbafc35a9d7beb880f3ecf98a8d563bd31153367490358db7
Upload date
Uploaded using Trusted Publishing?
What is 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

Security for PyHackTheBox 0.5.6.post1

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

No provenance found

None of the files in this release were uploaded with provenance metadata.

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.

To learn more about protecting yourself from malicious actors, visit our package security documentation.

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page