Skip to content

h0uter/humid

Repository files navigation

text Downloads tests PDM pre-commit Ruff Built with Material for MkDocs


Table of Contents
  1. About the Project
  2. Quickstart
  3. Why humid?

About the Project

alt text

humid makes it easy to generate human Friendly uuid's (hfid's) that are readable and pronounceable. Creation follows the pattern: {ADJECTIVE}-{ANIMAL|POKEMON}-{UUID*22}.

Quickstart

Install and run from shell

> pip install humid
> python -m humid
archaic-goose-y8yMIYjt91V8cejIxMa6G4
# or
> humid
archaic-goose-y8yMIYjt91V8cejIxMa6G4

Use in Python code

>> from humid import hfid

>> uuid = hfid()
>> print(uuid)
archaic-goose-y8yMIYjt91V8cejIxMa6G4

Why HUMan friendly IDs?

  • Improved Usability and Readability:: Human friendly IDs are easier to remember, recognize, and read compared to traditional IDs (like UUIDs or hashes). For example, instead of dealing with an ID like 4f52a6c7-e938-4d5e-9ad6-d89d62c7a90b, a human friendly ID such as archaic-goose-y8yMIYjt91V8cejIxMa6G4 is far more user-friendly.

  • Enhanced Communication:: When IDs are readable, they can be easily communicated over different channels, such as spoken language, emails, or text messages. This is especially useful in contexts like customer support or during collaborative work sessions, where team members need to quickly and accurately communicate specific IDs.