README.md

WordSearch

A Word Search Generator for Python.

---

How to use

---

How to import the the word search Generator

from WordSearch import WordSearch

How to initialize the WordSearch Object

# words = a variable with all the words, which are all separated by a comma.
# Note : the variable which contains all words mustn't be called words.
words = ("Hello,Blah,Superhero")
x = 40
y = 40
# x & y indicate the size of the word search.
# Note: When you take a look at our code, you will see 'grid' (a list).
#Grid is a a list which contains lists(columns) which contain letters (strings). 
w = WordSearch(words,x,y)

What can a Word search object do?

---

Methods

WordSearch.letter(row, column)
Description: it returns a letter (string) in the defined parameters
WordSearch.findWords(words)
Description: it searches the words in Grid. (Note: words is a list and is not seperated by commas.) It returns a dictionary where the key is the word and value is a list of tuples(Note:that the tuples are in that order: (y,x)) of the positions the letters

Properties

WordSearch.Grid
Description: It is the WordSearch Grid where all letters are stored.
WordSearch.maxX
Description: The "x" value you defined at the start of generating the object.
WordSearch.maxY
Description: The "y" value you defined at the start of generating the object.