Skip to main content

HardGuard25: A human-friendly unique ID alphabet. 25 unambiguous characters.

Project description

hardguard25

Python reference implementation of HardGuard25 — an open standard for human-safe identifiers.

0 1 2 3 4 5 6 7 8 9 A C D F G H J K M N P R U W Y

HardGuard25 is a 25-character alphabet designed so every symbol is visually distinct in any typeface, at any size, for any reader — including those with dyslexia. It removes 11 letters that cause real-world errors (I L O B S Z E T V X Q) so IDs survive handwriting, phone calls, OCR, and support tickets without corrections. When a letter and a digit compete for the same visual slot, the digit always wins.

Install

pip install hardguard25

Requires Python 3.9+.

Quickstart

from hardguard25 import generate, validate, normalize, check_digit, verify_check_digit

generate(8)                       # e.g. "AC3H7PUW"
generate(8, check_digit=True)     # e.g. "AC3H7PUWR"  (length+1)

validate("ac3h-7puw")             # True  (case and separators tolerated)
normalize("ac3h-7puw")            # "AC3H7PUW"

check_digit("AC3H7PUW")           # "R"
verify_check_digit("AC3H7PUWR")   # True

API

Function Purpose
generate(length, *, check_digit=False) Cryptographically secure random ID using rejection sampling for uniform distribution
validate(s) True if s normalizes to a valid HardGuard25 ID; never raises
normalize(s) Trim, uppercase, strip - _ . and spaces; raises ValueError on invalid chars
check_digit(code) Mod-25 weighted check digit (ISO 7064 style)
verify_check_digit(code) Strip last char, recompute, compare
ALPHABET "0123456789ACDFGHJKMNPRUWY"

Type hints and py.typed marker included.

Sizing

Each character carries log2(25) = 4.64 bits of entropy.

Length Bits Unique IDs Typical Use
4 18.6 390,625 Small inventory, tickets
5 23.2 9,765,625 Small business
6 27.9 244,140,625 Medium businesses
7 32.5 6.1 billion Large catalogs
8 37.2 152.6 billion Large systems
12 55.7 5.96 × 10¹⁶ Internal tokens
16 74.2 3.55 × 10²² Cross-system IDs
20 92.8 2.11 × 10²⁷ Public tokens
22 102.1 1.32 × 10³⁰ Internet-scale

Recommended defaults:

  • 16 for internal systems up to millions of IDs
  • 20 for public tokens or cross-org use
  • 22 for long-lived, internet-scale identifiers

See the spec for collision-bound tables.

When NOT to Use HardGuard25

  • Cryptographic keys (use proper key derivation)
  • Blockchain consensus (use domain-specific formats)
  • Systems requiring global UUID guarantees (use UUIDv7 or ULID)
  • Machine-only contexts where no human ever sees the ID

Reference

License

MIT

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

hardguard25-1.3.1.tar.gz (7.3 kB view details)

Uploaded Source

Built Distribution

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

hardguard25-1.3.1-py3-none-any.whl (6.0 kB view details)

Uploaded Python 3

File details

Details for the file hardguard25-1.3.1.tar.gz.

File metadata

  • Download URL: hardguard25-1.3.1.tar.gz
  • Upload date:
  • Size: 7.3 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.14.3

File hashes

Hashes for hardguard25-1.3.1.tar.gz
Algorithm Hash digest
SHA256 6802d7b22f1f626123f01ba79384e1377fc63c5c94d7641fd4b319baa7bbb5f9
MD5 93872093f8672e430aa513c358fba781
BLAKE2b-256 1afbb4f9c59688169a4fc5fc531736668e8fc60438a02e738aeb6474f7128943

See more details on using hashes here.

File details

Details for the file hardguard25-1.3.1-py3-none-any.whl.

File metadata

  • Download URL: hardguard25-1.3.1-py3-none-any.whl
  • Upload date:
  • Size: 6.0 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.14.3

File hashes

Hashes for hardguard25-1.3.1-py3-none-any.whl
Algorithm Hash digest
SHA256 b79a1966c8cef20b7acdc2f4fb46a1a911ad25c74c6890628773f8d438703127
MD5 82a4158f134849668ad1c90b2aead89f
BLAKE2b-256 cdfe6f77c7190c8b9f12d0af97f49d6449fe5c799c304a567c39b1595f36e79e

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