aboutsummaryrefslogtreecommitdiffstats
path: root/README.md
blob: 29d3ddd7116ae76cb32b2c375e925d825ee77e7e (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
# Random Pet Name Generator

This tool uses the [PGP Biometric word list](https://en.wikipedia.org/wiki/PGP_word_list) to generate random n-word pet names, a la Docker friendly names.

## Installation

    pip3 install -r requirements.txt


## Usage

    ./pet_names [m] [n]

        Generate m random pet names, n words in length. If no value is supplied, the tool defaults to generating one two-word pet name.

## Example

    ./pet_names 2 3
    talon_publisher_scenic
    trauma_ohio_zulu