marko-namo 0.2.0

Markov chain project name generator

Marko-Namo

Simple tool to generate random project or business names using a basic Markov Chain approach.

How It Words

The generator starts by creating a frequency table based on the training words supplied and the n-grams listed. Eg if our training word is hello and our n-grams are 1 and 2, we'd get a frequency table of:

{
    "h": ["e", "el"],
    "he": ["l", "ll"],
    "e": ["l", "ll"],
    "el": ["l", "lo"],
    "l": ["l", "lo", "o", null],
    "ll": ["o", null],
    "lo": [null, null],
    "o": [null, null]
}

It then randomly selects an n-gram from the frequency table as the first letter, randomly selects a following letter and repeats until the word either ends (selects a None) or reaches the maximum word length.

Eg if the first selected letter was e we might go:

• e -> l -> lo -> None
• Which gives ello

How To Run

Everything is controlled via the configuration file (config.yml)

To get started, rename the config_sample.yml to config.yml and remove the GoDaddy references. Then run the app:

python generate_names.py

Parameters

Parameter	Type	Description
number_of_names	Integer	Number of names to attempt to create
maximum_name_length	Integer	Maximum name length. Note names can be up to length + largest n-gram in length
n_grams	List of integers	The word segment lengths to consider for learning and generating new words.
extensions	List of strings	Domain extensions to check for such as .com, .ai, etc
training_words	List of strings	Words to learn from and used to generate new, random, words. There's no limit to the number of words to learn from but too many will slow the program down significantly.

Domain Name Lookup

If you'd like to check if the domain name (eg www.randomname.com) is available for the generated names then you'll also need a GoDaddy API key. This can be generated at the following: https://developer.godaddy.com/keys

Testing

Nox is used handle test automation. To run the tests:

1. Register with GoDaddy and generate OTE & PROD keys
2. Set them as environment variables:

# GoDaddy OTE
GODADDY_OTE_KEY=<OTE Key>
GODADDY_OTE_SECRET=<OTE Secret>

# GoDaddy Prod
GODADDY_PROD_KEY=<Prod Key>
GODADDY_PROD_SECRET=<Prod Secret>

3. Install nox if not already available
4. Run the tests:

nox