# Word-Search-Generator
Word-Search-Generator is a Python module for generating fun [Word Search Puzzles](https://en.wikipedia.org/wiki/Word_search).
[](https://github.com/joshbduncan/word-search-generator/actions/workflows/tests.yml)  [](https://badge.fury.io/py/word-search-generator)
đ¤Ļââī¸ Does the world need this? Probably not.
â° Did I spend way too much time on it? Yep!
â
Does it come in handy? Heck yeah!
đ Did I have fun making it? Absofreakinglutly!
## Installation
Install Word-Search-Generator with `pip`:
$ pip install word-search-generator
## Usage
Just import the WordSearch class from the package, supply it with a list of words and you're set. đ§Š
```pycon
>>> from word_search_generator import WordSearch
>>> puzzle = WordSearch("dog, cat, pig, horse, donkey, turtle, goat, sheep")
```
## Options
If you dig deep enough, you'll notice this package is completely overkill... There are numerous options and lots of possibilities. You can learn more by viewing the source code or checking out the project [Wiki](https://github.com/joshbduncan/word-search-generator/wiki).
đ Wanna see it?
```pycon
>>> puzzle.show() # or print(puzzle)
---------------------------
WORD SEARCH
---------------------------
A G W K F B P V C U F U H R
B O I E U H W M I V P D K E
H N G S B P S J L N E Y X C
I J H V E G Y A X S T K J Q
F V Q E H F V E R B V A X K
U E H L A N I O K D J L T A
K S V P S C H C L O G D R F
Z F K I D N J D V N O P N D
C D N G T Y C N U K A I Q W
S O E Q V D B P I E T S M Y
X N T U R T L E G Y R K E K
T S I P I C T O R N S H O U
H U Q X M A D I G K T V C E
N T N I C I Q W M Q C I H P
Find these words: CAT, DOG, DONKEY, GOAT, HORSE, PIG, SHEEP, TURTLE
* Words can go E, SE, NE, and, S.
Answer Key: CAT NE @ (5, 14), DOG NE @ (7, 13), DONKEY S @ (10, 6), GOAT S @ (11, 7), HORSE NE @ (7, 7), PIG S @ (4, 7), SHEEP NE @ (2, 7), TURTLE E @ (3, 11)
```
âšī¸ The answer key uses 1-based indexing and a familiar (x, y) coordinate system. Directions are cardinal from first letter to last. \* Please note that all key values inside of the api are 0-based.
đ° Too easy? Up the difficulty level.
```pycon
>>> puzzle.level = 3
>>> puzzle.show()
---------------------------
WORD SEARCH
---------------------------
A G W K F B P V C U F U H R
B O I E U H W M I V P D K E
H N G S B P S J L N E Y X C
I J H V E G Y A X S T K J Q
F V Q E H F V E R B V A X K
U E H L A N I O K D J L T A
K S V P S C H C L O G D R F
Z F K I D N J D V N O P N D
C D N G T Y C N U K A I Q W
S O E Q V D B P I E T S M Y
X N T U R T L E G Y R K E K
T S I P I C T O R N S H O U
H U Q X M A D I G K T V C E
N T N I C I Q W M Q C I H P
Find these words: CAT, DOG, DONKEY, GOAT, HORSE, PIG, SHEEP, TURTLE
* Words can go SE, E, N, W, SW, NE, S, and, NW.
Answer Key: CAT NE @ (5, 14), DOG NE @ (7, 13), DONKEY S @ (10, 6), GOAT S @ (11, 7), HORSE NE @ (7, 7), PIG S @ (4, 7), SHEEP NE @ (2, 7), TURTLE E @ (3, 11)
```
đ Want a custom level?
Specify custom cardinal directions for your puzzle words (e.g. N, NE, E, SE, S, SW, W, NW).
```pycon
>>> puzzle.directions = "NW,SW"
>>> puzzle.show()
---------------------------
WORD SEARCH
---------------------------
M L N C W X Q S V M G I A F
D J A T F O H J E Q R D C U
C T U L G E A G A Z O Z G R
O M O A E H Y M D G P O I B
W H Z P O Q F O I Q A B Y P
K J O R G C N M F T Z N T L
W Z S Q J K E D Q V Y U R W
F E C D E X N P L D R I L K
G K I Y F Z J S J T M P E V
Z M G P V N W G L C F H F W
S Q O E L F A E I H E Q X T
V I V P H X D Q Z P T M P O
F A D G O R L F Y J B X K E
H G M S Z B D M W M R L H N
Find these words: CAT, DOG, DONKEY, GOAT, HORSE, PIG, SHEEP, TURTLE
* Words can go SW, and, NW.
Answer Key: CAT SW @ (4, 1), DOG SW @ (12, 2), DONKEY SW @ (9, 4), GOAT SW @ (13, 3), HORSE SW @ (6, 4), PIG NW @ (10, 12), SHEEP SW @ (8, 1), TURTLE SW @ (13, 6)
```
đą Still too easy? Go expert mode.
```pycon
>>> from word_search_generator import WordSearch
>>> puzzle = WordSearch(level=3)
>>> puzzle.random_words(10, secret=True, reset_size=True)
```
đ Too hard? Go the easy route with `puzzle.level = 1` or `puzzle.directions = "E"`.
đ How about adding a mask ([docs](https://github.com/joshbduncan/word-search-generator/wiki/Puzzle-Masking))? ...Fancy!
```pycon
>>> from word_search_generator.mask.shapes import Heart
>>> puzzle.apply_mask(Heart())
>>> puzzle.show()
-------------------------
WORD SEARCH
-------------------------
C L C C Y E
Q S T N S T E L D K
Z L O Z T P A K T H N M W
C C L Q C O N R S P Z V U
M I X V G O U R H S Z C H
M H K D T T L E C U Q
H C T H O R S E B M
Z I S W R B P E G
Y P I G B X Q
C A T N G
A R W O
K D Q
A
Find these words: CAT, DOG, DONKEY, GOAT, HORSE, PIG, SHEEP, TURTLE
* Words can go S, NE, E, and, SE.
Answer Key: CAT E @ (5, 10), DOG NE @ (7, 12), DONKEY NE @ (5, 6), GOAT NE @ (5, 5), HORSE E @ (5, 7), PIG E @ (5, 9), SHEEP S @ (9, 4), TURTLE NE @ (6, 6)
```
đž Save your AWESOME puzzle as a PDF.
```pycon
>>> puzzle.save(path="~/Desktop/puzzle.pdf")
>>> "~/Desktop/puzzle.pdf"
```
## đĨ CLI Integration
You can play WordSearch in your CLI too ([docs](https://github.com/joshbduncan/word-search-generator/wiki/Command-Line-Interface-(CLI)))! WordSearch Generator installs the console entry-point `word-search` so you can interact with the package right in your console.
```bash
$ word-search -r 10 -s 15 -l 3
-----------------------------
WORD SEARCH
-----------------------------
J W X O X N A Q C A Q Z D R G
F B D M Y S E L F Z F N A K F
G K N E Q H D O P X Y T I G Z
V F C F T Y F Z S U E N D Y J
W A X P C K L B T B D I X T C
Y R C J Y P G R M L R V C O E
D K H Z C V Y I Z Q H B I P X
W U J D O S H N M T S O A U Q
L K C E M L V G S L F H F R Z
A F L Y A J K N F Z A Z T P D
E K P E Z P R M B P W C E O M
D N J G Y E F T H E S E R S J
B X Z P D B A B Y T C W J E F
E G L O F X E X P U P O V N A
M I M J Y S F N C H C F R P K
Find these words: AFTER, BABY, BRING, DEAL, KIND, MODERN, MYSELF, PURPOSE, RATE, THESE
* Words can go N, S, SW, W, E, NW, NE, and, SE.
Answer Key: AFTER S @ (13, 8), BABY E @ (6, 13), BRING S @ (8, 5), DEAL N @ (1, 12), KIND SW @ (14, 2), MODERN NE @ (3, 15), MYSELF E @ (4, 2), PURPOSE S @ (14, 7), RATE SW @ (14, 1), THESE E @ (8, 12)
```
## đ Documentation
If you need more info, most of the fun parts of Word-Search-Generator are documented on Github in the [Project Wiki](https://github.com/joshbduncan/word-search-generator/wiki).
Happy WordSearching âī¸
Raw data
{
"_id": null,
"home_page": "",
"name": "word-search-generator",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.7",
"maintainer_email": "",
"keywords": "puzzles,games,word-search",
"author": "",
"author_email": "Josh Duncan <joshbduncan@gmail.com>",
"download_url": "https://files.pythonhosted.org/packages/4e/f2/1798c53c057f7741006acd770f369faf173b04ea897cc075915dd17ae0e9/word-search-generator-3.5.0.tar.gz",
"platform": null,
"description": "# Word-Search-Generator\n\nWord-Search-Generator is a Python module for generating fun [Word Search Puzzles](https://en.wikipedia.org/wiki/Word_search).\n\n[](https://github.com/joshbduncan/word-search-generator/actions/workflows/tests.yml)  [](https://badge.fury.io/py/word-search-generator)\n\n\n\n\ud83e\udd26\u200d\u2642\ufe0f Does the world need this? Probably not. \n\u23f0 Did I spend way too much time on it? Yep! \n\u2705 Does it come in handy? Heck yeah! \n\ud83d\udc4d Did I have fun making it? Absofreakinglutly!\n\n## Installation\n\nInstall Word-Search-Generator with `pip`:\n\n $ pip install word-search-generator\n\n## Usage\n\nJust import the WordSearch class from the package, supply it with a list of words and you're set. \ud83e\udde9\n\n```pycon\n>>> from word_search_generator import WordSearch\n>>> puzzle = WordSearch(\"dog, cat, pig, horse, donkey, turtle, goat, sheep\")\n```\n\n## Options\n\nIf you dig deep enough, you'll notice this package is completely overkill... There are numerous options and lots of possibilities. You can learn more by viewing the source code or checking out the project [Wiki](https://github.com/joshbduncan/word-search-generator/wiki).\n\n\ud83d\udc40 Wanna see it?\n\n```pycon\n>>> puzzle.show() # or print(puzzle)\n---------------------------\n WORD SEARCH\n---------------------------\nA G W K F B P V C U F U H R\nB O I E U H W M I V P D K E\nH N G S B P S J L N E Y X C\nI J H V E G Y A X S T K J Q\nF V Q E H F V E R B V A X K\nU E H L A N I O K D J L T A\nK S V P S C H C L O G D R F\nZ F K I D N J D V N O P N D\nC D N G T Y C N U K A I Q W\nS O E Q V D B P I E T S M Y\nX N T U R T L E G Y R K E K\nT S I P I C T O R N S H O U\nH U Q X M A D I G K T V C E\nN T N I C I Q W M Q C I H P\n\nFind these words: CAT, DOG, DONKEY, GOAT, HORSE, PIG, SHEEP, TURTLE\n* Words can go E, SE, NE, and, S.\n\nAnswer Key: CAT NE @ (5, 14), DOG NE @ (7, 13), DONKEY S @ (10, 6), GOAT S @ (11, 7), HORSE NE @ (7, 7), PIG S @ (4, 7), SHEEP NE @ (2, 7), TURTLE E @ (3, 11)\n```\n\n\u2139\ufe0f The answer key uses 1-based indexing and a familiar (x, y) coordinate system. Directions are cardinal from first letter to last. \\* Please note that all key values inside of the api are 0-based.\n\n\ud83c\udf70 Too easy? Up the difficulty level.\n\n```pycon\n>>> puzzle.level = 3\n>>> puzzle.show()\n---------------------------\n WORD SEARCH\n---------------------------\nA G W K F B P V C U F U H R\nB O I E U H W M I V P D K E\nH N G S B P S J L N E Y X C\nI J H V E G Y A X S T K J Q\nF V Q E H F V E R B V A X K\nU E H L A N I O K D J L T A\nK S V P S C H C L O G D R F\nZ F K I D N J D V N O P N D\nC D N G T Y C N U K A I Q W\nS O E Q V D B P I E T S M Y\nX N T U R T L E G Y R K E K\nT S I P I C T O R N S H O U\nH U Q X M A D I G K T V C E\nN T N I C I Q W M Q C I H P\n\nFind these words: CAT, DOG, DONKEY, GOAT, HORSE, PIG, SHEEP, TURTLE\n* Words can go SE, E, N, W, SW, NE, S, and, NW.\n\nAnswer Key: CAT NE @ (5, 14), DOG NE @ (7, 13), DONKEY S @ (10, 6), GOAT S @ (11, 7), HORSE NE @ (7, 7), PIG S @ (4, 7), SHEEP NE @ (2, 7), TURTLE E @ (3, 11)\n```\n\n\ud83c\udf9b Want a custom level?\n\nSpecify custom cardinal directions for your puzzle words (e.g. N, NE, E, SE, S, SW, W, NW).\n\n```pycon\n>>> puzzle.directions = \"NW,SW\"\n>>> puzzle.show()\n---------------------------\n WORD SEARCH\n---------------------------\nM L N C W X Q S V M G I A F\nD J A T F O H J E Q R D C U\nC T U L G E A G A Z O Z G R\nO M O A E H Y M D G P O I B\nW H Z P O Q F O I Q A B Y P\nK J O R G C N M F T Z N T L\nW Z S Q J K E D Q V Y U R W\nF E C D E X N P L D R I L K\nG K I Y F Z J S J T M P E V\nZ M G P V N W G L C F H F W\nS Q O E L F A E I H E Q X T\nV I V P H X D Q Z P T M P O\nF A D G O R L F Y J B X K E\nH G M S Z B D M W M R L H N\n\nFind these words: CAT, DOG, DONKEY, GOAT, HORSE, PIG, SHEEP, TURTLE\n* Words can go SW, and, NW.\n\nAnswer Key: CAT SW @ (4, 1), DOG SW @ (12, 2), DONKEY SW @ (9, 4), GOAT SW @ (13, 3), HORSE SW @ (6, 4), PIG NW @ (10, 12), SHEEP SW @ (8, 1), TURTLE SW @ (13, 6)\n```\n\ud83d\ude31 Still too easy? Go expert mode.\n\n```pycon\n>>> from word_search_generator import WordSearch\n>>> puzzle = WordSearch(level=3)\n>>> puzzle.random_words(10, secret=True, reset_size=True)\n```\n\n\ud83d\ude13 Too hard? Go the easy route with `puzzle.level = 1` or `puzzle.directions = \"E\"`.\n\n\ud83c\udfad How about adding a mask ([docs](https://github.com/joshbduncan/word-search-generator/wiki/Puzzle-Masking))? ...Fancy!\n\n```pycon\n>>> from word_search_generator.mask.shapes import Heart\n>>> puzzle.apply_mask(Heart())\n>>> puzzle.show()\n-------------------------\n WORD SEARCH\n-------------------------\n C L C C Y E\n Q S T N S T E L D K\nZ L O Z T P A K T H N M W\nC C L Q C O N R S P Z V U\nM I X V G O U R H S Z C H\n M H K D T T L E C U Q\n H C T H O R S E B M\n Z I S W R B P E G\n Y P I G B X Q\n C A T N G\n A R W O\n K D Q\n A\n\nFind these words: CAT, DOG, DONKEY, GOAT, HORSE, PIG, SHEEP, TURTLE\n* Words can go S, NE, E, and, SE.\n\nAnswer Key: CAT E @ (5, 10), DOG NE @ (7, 12), DONKEY NE @ (5, 6), GOAT NE @ (5, 5), HORSE E @ (5, 7), PIG E @ (5, 9), SHEEP S @ (9, 4), TURTLE NE @ (6, 6)\n```\n\n\ud83d\udcbe Save your AWESOME puzzle as a PDF.\n\n```pycon\n>>> puzzle.save(path=\"~/Desktop/puzzle.pdf\")\n>>> \"~/Desktop/puzzle.pdf\"\n```\n\n## \ud83d\udda5 CLI Integration\n\nYou can play WordSearch in your CLI too ([docs](https://github.com/joshbduncan/word-search-generator/wiki/Command-Line-Interface-(CLI)))! WordSearch Generator installs the console entry-point `word-search` so you can interact with the package right in your console.\n\n```bash\n$ word-search -r 10 -s 15 -l 3\n-----------------------------\n WORD SEARCH\n-----------------------------\nJ W X O X N A Q C A Q Z D R G\nF B D M Y S E L F Z F N A K F\nG K N E Q H D O P X Y T I G Z\nV F C F T Y F Z S U E N D Y J\nW A X P C K L B T B D I X T C\nY R C J Y P G R M L R V C O E\nD K H Z C V Y I Z Q H B I P X\nW U J D O S H N M T S O A U Q\nL K C E M L V G S L F H F R Z\nA F L Y A J K N F Z A Z T P D\nE K P E Z P R M B P W C E O M\nD N J G Y E F T H E S E R S J\nB X Z P D B A B Y T C W J E F\nE G L O F X E X P U P O V N A\nM I M J Y S F N C H C F R P K\n\nFind these words: AFTER, BABY, BRING, DEAL, KIND, MODERN, MYSELF, PURPOSE, RATE, THESE\n* Words can go N, S, SW, W, E, NW, NE, and, SE.\n\nAnswer Key: AFTER S @ (13, 8), BABY E @ (6, 13), BRING S @ (8, 5), DEAL N @ (1, 12), KIND SW @ (14, 2), MODERN NE @ (3, 15), MYSELF E @ (4, 2), PURPOSE S @ (14, 7), RATE SW @ (14, 1), THESE E @ (8, 12)\n```\n\n## \ud83d\udcd4 Documentation\n\nIf you need more info, most of the fun parts of Word-Search-Generator are documented on Github in the [Project Wiki](https://github.com/joshbduncan/word-search-generator/wiki).\n\nHappy WordSearching \u270c\ufe0f\n",
"bugtrack_url": null,
"license": "MIT License",
"summary": "Make awesome Word Search puzzles",
"version": "3.5.0",
"project_urls": {
"bug-tracker": "https://github.com/joshbduncan/word-search-generator/issues",
"changelog": "https://github.com/joshbduncan/word-search-generator/blob/main/CHANGLOG.md",
"documentation": "https://github.com/joshbduncan/word-search-generator/wiki",
"homepage": "https://github.com/joshbduncan/word-search-generator",
"repository": "https://github.com/joshbduncan/word-search-generator.git"
},
"split_keywords": [
"puzzles",
"games",
"word-search"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "26819c7b166e81b3e769d07427bc0a2826a625e48af1a76e3ea2995ec1715a7e",
"md5": "4c2befa374727f8659b7ad409e9c23aa",
"sha256": "785091cb9f837d3b7dde9ec70c965374b6985efbaf70dc40c96243975dd70514"
},
"downloads": -1,
"filename": "word_search_generator-3.5.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "4c2befa374727f8659b7ad409e9c23aa",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.7",
"size": 40980,
"upload_time": "2023-07-07T18:40:54",
"upload_time_iso_8601": "2023-07-07T18:40:54.657915Z",
"url": "https://files.pythonhosted.org/packages/26/81/9c7b166e81b3e769d07427bc0a2826a625e48af1a76e3ea2995ec1715a7e/word_search_generator-3.5.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "4ef21798c53c057f7741006acd770f369faf173b04ea897cc075915dd17ae0e9",
"md5": "d823f68b47b580f6048f4b67e7b2cc09",
"sha256": "72bc52ddf57437eec0159c7100190751ed3352ac015c9b2ef6c8aa41c4d315e7"
},
"downloads": -1,
"filename": "word-search-generator-3.5.0.tar.gz",
"has_sig": false,
"md5_digest": "d823f68b47b580f6048f4b67e7b2cc09",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.7",
"size": 60087,
"upload_time": "2023-07-07T18:40:59",
"upload_time_iso_8601": "2023-07-07T18:40:59.307563Z",
"url": "https://files.pythonhosted.org/packages/4e/f2/1798c53c057f7741006acd770f369faf173b04ea897cc075915dd17ae0e9/word-search-generator-3.5.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-07-07 18:40:59",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "joshbduncan",
"github_project": "word-search-generator",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"requirements": [],
"tox": true,
"lcname": "word-search-generator"
}
JSON
