friendly_names 0.1.0

No project description provided

friendly_names

A super simple random friendly name generator that creates readable, hyphenated names like "red-loop-bounty".

---

Table of Contents

• Installation
• Usage
• Development
• Release Process
• License

Installation

pip install friendly_names

Usage

import friendly_names

# Generate a friendly name like "red-loop-bounty"
name = friendly_names.generate()

# Customize number of words
name = friendly_names.generate(words=4)  # e.g., "happy-blue-running-fox"

# Use different separator
name = friendly_names.generate(separator="_")  # e.g., "green_swift_river"

Development

To set up the development environment:

pip install hatch

Common development tasks:

# Run tests
hatch run test:test

# Run tests with coverage
hatch run test:coverage

# Run type checking
hatch run types:check

# Check code style
hatch run lint:style

# Format code
hatch run lint:fmt

The project uses:

• Hatch for development environment and build management
• pytest for testing
• mypy for type checking
• Ruff for linting and formatting
• Black style rules (via Ruff)

Release Process

To release a new version:

1. Update version in src/friendly_names/__about__.py
2. Commit the change:

   git add src/friendly_names/__about__.py
   git commit -m "Bump version to x.y.z"
   

3. Tag the release:

   git tag -a vx.y.z -m "Release version x.y.z"
   

4. Push changes and tag:

   git push origin master
   git push origin vx.y.z
   

The GitHub Actions workflow will automatically build and publish to PyPI when the tag is pushed.

License

friendly_names is distributed under the terms of the MIT license.