Word Search

Python package that searches a 2D grid of randomly generated letters (a-z only) for valid English words. Words can be found along any diagonal, forwards, upwards, downwards or backwards and cannot ‘wrap’ between edges. To check if a word is valid, a list of words at res/input/words.txt is used as a reference dictionary.

Project Highlights

• Run source

# cd PROJECT_ROOT
# python  <module-filename>                    <word-list-file>      <cols>   <rows>
python    word_search/word_search_hashset.py   res/input/words.txt   15       15
python    word_search/word_search_trie.py      res/input/words.txt   15       15

• Run unit test

# cd PROJECT_ROOT
python -m unittest discover word_search/

• Run unit test with code coverage using Coverage.py

# cd PROJECT_ROOT
coverage run --source=word_search/ -m unittest discover word_search/
coverage report

• Code coverage results

Name                                                             Stmts   Miss  Cover
------------------------------------------------------------------------------------
word_search/__init__.py                                              0      0   100%
word_search/test/__init__.py                                         0      0   100%
word_search/test/test_word_search_correctness_by_comparison.py      36      8    78%
word_search/test/test_word_search_hashset.py                        24      0   100%
word_search/test/test_word_search_trie.py                           15      0   100%
word_search/word_search_hashset.py                                 190     27    86%
word_search/word_search_trie.py                                    224     29    87%
------------------------------------------------------------------------------------
TOTAL                                                              489     64    87%

• Create source distribution

# cd PROJECT_ROOT
python setup.py sdist

• Install package from pypi.org/project/word-search

  pip install word_search --user

  or

  pip install word-search --user

• Install package from this repository

  • Normal Install

  # cd PROJECT_ROOT
  pip install . --user

  • Development Install

  # cd PROJECT_ROOT
  pip install -e . --user

• Check package installation

  pip --user freeze | grep word_search

• Uninstall package

  pip uninstall word_search

  or

  pip uninstall word-search

• For package usage see client/client_example.py

  from word_search import word_search_hashset as hs
  from word_search import word_search_trie as ts

References

• Implementing a Trie in Python - towardsdatascience.com
• What is the best project structure for a Python application? - stackoverflow.com
  • According to Jean-Paul Calderone's Filesystem structure of a Python project
  • Open Sourcing a Python Project the Right Way
• Package And Distribute Python Applications - digitalocean.com
• Python Packaging User Guide, Tool recommendations - packaging.python.org
• pypi and testpypi