Metadata-Version: 2.1
Name: word-tree
Version: 1.1.1
Summary: Dictionary optimised for progressive lookup
Home-page: https://gitlab.com/OldIronHorse/word_tree
Author: Simon Redding
Author-email: s1m0n.r3dd1ng@gmail.com
License: GPL3
Keywords: dictionary word incremental lookup
Platform: UNKNOWN
Description-Content-Type: text/markdown

# Word Tree [![pipeline status](https://gitlab.com/OldIronHorse/word_tree/badges/master/pipeline.svg)](https://gitlab.com/OldIronHorse/word_tree/-/commits/master) [![coverage report](https://gitlab.com/OldIronHorse/word_tree/badges/master/coverage.svg)](https://gitlab.com/OldIronHorse/word_tree/-/commits/master)


Efficient lookup of next possible character(s) given a starting word fragment.

This is intended for use in word game strategies (Boggle, Scrabble, Anagram).

Usage:

```
>>> import word_tree
>>> with open('words.lst') as wl:
...   wt = word_tree.make_word_tree([w.strip() for w in wl])
...
>>> wt.next_char('do')
['c', 'e', 'd', 'g', 'i', 'm', 'l', 'o', 'n', 'p', 's', 'r', 'u', 't', 'w', 'v', 'z', None]
```

