Skip to content

brass75/wordsearch

Repository files navigation

py-wordsearch-gen - Word Search Generator

Ruff Tests Mastodon Follow

py-wordsearch-gen is a word search generator, originally written to generate a word search for distribution at the PSF booth at PyCon US 2025. It is incredibly simple to use and will generate a new word search with every run.

Installation

Installation is easy:

pip install py-wordsearch-gen

Usage

To use just run wordsearch from the command line.

usage: wordsearch.py [-h] [-w [WIDTH]] [-t [HEIGHT]] [-m [MIN_WORD]] [-d] [-r] [-k] [-x [EXCLUDED_LETTERS]] words [words ...]

Word Search Generator

positional arguments:
  words                 List of words for the search.

options:
  -h, --help            show this help message and exit
  -w, --width [WIDTH]   Width of puzzle, (Default: 10)
  -t, --height [HEIGHT]
                        Height of puzzle, If not set will be the same as the width (square puzzle.)
  -m, --min [MIN_WORD]  The minimum word length. Cannot be larger than the size of the grid. (Default: 4)
  -d, --diagonal        Allow words to be placed diagonally.
  -r, --reverse         Allow words to be placed backwards.
  -k, --answer-key      Print the answer key ahead of the puzzle.
  -x, --exclude [EXCLUDED_LETTERS]
                        A list of letters to be excluded as fill. Defaults to 'JQXZ'

About

Word Search Generator

Resources

License

Stars

Watchers

Forks

Packages

 
 
 

Contributors

Languages