Skip to main content

Documentation Index

Fetch the complete documentation index at: https://mintlify.com/Zozi96/hash-forge/llms.txt

Use this file to discover all available pages before exploring further.

Hash Forge is published to PyPI and installs with a single pip command. The base package has zero required third-party dependencies — algorithms backed by Python’s standard library (PBKDF2, Scrypt, BLAKE2, SHA-3) work immediately after install. Algorithms that depend on external C extensions are gated behind named extras so you only pull in what you actually use.
Python 3.11 or later is required. Hash Forge is tested against CPython 3.11, 3.12, 3.13, and 3.14 on every release. The build system is hatchling.

​
Installation Steps

1

Install the base package

Run the following command in your terminal to install Hash Forge with its zero-dependency core:
pip install hash-forge
This gives you full access to PBKDF2-SHA256, PBKDF2-SHA1, Scrypt, BLAKE2, SHA-3 256, and SHA-3 512 — all implemented using Python’s hashlib and hmac standard library modules.
2

Install optional extras (if needed)

If your project requires bcrypt, Argon2, RIPEMD-160, Whirlpool, or BLAKE3, install the corresponding extra. Each extra brings in only the single package required for that algorithm group.
Enables BCryptHasher and BCryptSha256Hasher.
pip install "hash-forge[bcrypt]"
Installs: bcrypt==5.0.0
Using a hasher whose extra is not installed raises an ImportError at import time. For example, importing Argon2Hasher without hash-forge[argon2] will fail immediately. Install the relevant extra before using these hashers.
3

Verify the installation

Confirm Hash Forge is installed correctly by printing its version:
import hash_forge
print(hash_forge.__version__)  # 3.2.0
You can also confirm which algorithms are available without any extras:
from hash_forge import HashManager

hm = HashManager.from_algorithms("pbkdf2_sha256", "scrypt", "blake2", "sha3_256")
print(hm.list_algorithms())
# ['pbkdf2_sha256', 'scrypt', 'blake2', 'sha3_256']

​
Optional Extras Reference

The table below summarises every extra, the package it pins, and the hashers it unlocks:
ExtraPinned DependencyUnlocked Hashers
bcryptbcrypt==5.0.0BCryptHasher, BCryptSha256Hasher
argon2argon2-cffi==25.1.0Argon2Hasher
cryptopycryptodome==3.23.0Ripemd160Hasher, WhirlpoolHasher
blake3blake3==1.0.7Blake3Hasher
No extras required for: PBKDF2Sha256Hasher, PBKDF2Sha1Hasher, ScryptHasher, Blake2Hasher, SHA3_256Hasher, and SHA3_512Hasher. These rely exclusively on Python’s standard library hashlib module and work out of the box after pip install hash-forge.

​
Build System

Hash Forge uses hatchling as its build backend. If you are consuming Hash Forge as a dependency inside your own package, no special build configuration is needed — pip install hash-forge resolves and builds everything automatically from PyPI.

Build docs developers (and LLMs) love

Get started for freeTalk to us