Skip to content

shaunhegarty/wordchain

Repository files navigation

Word Chain

A package to build word chains from a given list of words.

Tests

Installation

pip install python-wordchain

Sample Usage

from wordchain.wordchain import WordChainer

WORD_LIST = ["bird", "bind", "bord", "bond", "bend", "bing", "bong", "sing", "song"]

chainer = WordChainer(word_list=WORD_LIST)
chainer.get_chains('bird', 'song')

This yields:

[('bird', 'bord', 'bond', 'bong', 'song'),
 ('bird', 'bind', 'bing', 'sing', 'song'),
 ('bird', 'bind', 'bond', 'bong', 'song'),
 ('bird', 'bind', 'bing', 'bong', 'song')]

Testing

Running the test suite from repository root:

pytest -v tests/tests.py

Run tests using docker and tox:

docker run --rm $(docker build -q . -f Dockerfile.tox) tox

About

A package to build word chains from a given list of words.

Topics

Resources

License

Stars

Watchers

Forks

Languages