mattjegan / rancat

A random string generator using files as source lists.

Welcome to RanCat

Master

Develop

This is the full documentation of RanCat, an open source Python Random conCatenation engine.

Use Cases

RanCat is a string generator that can use multiple text sources, including files and native Python lists and tuples. What constitutes a word in a word list is simply an atomic entity in the source, e.g. a line in a file, or a value in a list. RanCat will generate pseudo-random strings that are suitable for use as :

• VCS Branch Names
• Database Names
• Project/Repository Names
• Online Avatar Names
• Baby Names
• and so on

Installation

pip install rancat

Basic Usage

from rancat import RanCat

r = RanCat()

# Load in our text sources
r.load(['red', 'orange', 'blue'])
r.load(['car', 'tractor', 'truck'])

# Generate a new string
r.next()
>>> orange_truck
r.next()
>>> red_tractor
r.next()
>>> orange_tractor

Contributing

Submitting an issue or feature request

If you find an issue or have a feature request please open an issue at Github RanCat Repo.

Working on issues

If you think that you can fix an issue or implement a feature, please make sure that it isn't assigned to someone or if it is you may ask for an update.

Once an issue is complete, open a pull request so that your contribution can be reviewed. A TravisCI build and CodeCov report will run and be attached to your pull request. Your code must pass these checks.

Helping others

At all times, please be polite with others who are working on issues. It may be their first ever patch and we want to foster a friendly and familiar open source environment.