Registry / serialization / friendlywords

friendlywords

library1.2.0pypypi✓ verified 85d ago

A Python library for generating random human-readable strings, such as project names, experiment names, or memorable identifiers. Version 1.2.0 supports Python >=3.6 and provides two-word combinations from adjective-noun pairs. The package is actively maintained with a stable API.

serialization

pip install friendlywords

github ↗package ↗

INSTALL

IMPORT

SIG · FRIENDLYWORDS

friendlywords

serializationpythonv1.2.0

Install

1.5s avg

Import

12ms

Disk

16MB

Pass rate

10/ 10

Env Coverage10 / 10

glibc

3.9–3.13

musl

3.9–3.13

Install & Compatibility

Where this runs

tested against v1.2.0 · pip install

no network on importno background threads

Install × environment matrix

Each cell = how many times install + import succeeded across repeated harness runs. Partial = flaky.
glibc = Debian/Ubuntu slim · musl = Alpine Linux

musl

py 3.10–3.95 runs

installs and imports cleanly · install 0.0s · import 0.012s · 17.9MB

glibc

py 3.10–3.95 runs

installs and imports cleanly · install 1.5s · import 0.012s · 18MB

16MB installed

● package 16MB

Code

Verified usage

Verified import paths — ran on the pinned version, not inferred.

generate

✓ from friendlywords import generate

✗ import friendlywords

Direct module import does not expose the function; must import from submodule.

Generate a single random human-readable string (adjective-noun pair).

from friendlywords import generate # Generate a random friendly word pair result = generate() print(result) # e.g., 'happy-eagle'

friendlywords --version

Debug

Known issues

gotchaThe generate() function returns a string with a hyphen by default, not a tuple or list. Users expecting multiple words may need to split on '-' or call generate(separator=' ').

fix

Use generate(separator=' ') for space-separated output, or call .split('-') if hyphen is used.

affects: >=1.0.0

deprecatedThe older import pattern 'import friendlywords' may work but is not recommended; the correct API requires 'from friendlywords import generate'. Future versions may drop the top-level module.

fix

Change import to: from friendlywords import generate

affects: <1.2.0

gotchaThe library does not provide a way to generate more than two words. All outputs are exactly an adjective and a noun.

fix

If you need longer strings, call generate() multiple times and join with a separator.

affects: >=1.0.0

Errors

Common errors & fixes

AttributeError: module 'friendlywords' has no attribute 'generate'

Using 'import friendlywords' instead of 'from friendlywords import generate'

fix

Change to: from friendlywords import generate

ModuleNotFoundError: No module named 'friendlywords'

Package not installed

fix

Run: pip install friendlywords

Upgrade

Version history

1.2.0latest on PyPI · released May 5, 2025

Audit

Dependencies

No dependency data recorded yet.

Agent activity

6 hits · last 30 days

node

Resources

githubhttps://github.com/the-lay/py-friendly-words ↗

packagehttps://pypi.org/project/friendlywords/ ↗