/aaanimal

🐯 Generate friendly, mostly unique names.

Primary LanguagePythonISC LicenseISC

Aaanimal

GitHub Actions test status Python versions License Any color you like

Aaanimal is a Python extension module for generating friendly, mostly unique names. The name is a play on GfyCat's AdjectiveAdjectiveAnimal URLs. It is written in Rust using PyO3.

Usage

Aaanimal only has one function. Use it wisely.

import aaanimal
aaanimal.generate()  # 'crushable-badtempered-raptors'
aaanimal.generate(adjectives=1, animals=1, separator=" ✨ ")  # 'nautical ✨ aphid'

Installation

The module is distributed to PyPI.

pip install aaanimal

You shouldn't need a Rust compiler unless you want to build from source.

Platform Support

There is currently only support for Linux, but the plan is to support Windows (and possibly FreeBSD) as well. If you'd like to help make either a reality, please consider contributing.