Skip to main content

Human Friendly UUIDs that are readable and pronounceable.

Project description

Downloads 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 readable uuid's (hrid'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 hrid

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

Why humid?

  • Improved Usability and Readability:: Human-readable IDs are easier to remember, recognize, and type compared to traditional IDs (like UUIDs or hashes). For example, instead of dealing with an ID like 4f52a6c7-e938-4d5e-9ad6-d89d62c7a90b, a human-readable 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.

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

humid-0.2.1.tar.gz (15.7 kB view hashes)

Uploaded Source

Built Distribution

humid-0.2.1-py3-none-any.whl (15.0 kB view hashes)

Uploaded Python 3

Supported by

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