Metadata-Version: 2.4
Name: wordsearch-gen
Version: 0.1.2
Summary: A customizable word search puzzle generator.
Home-page: https://github.com/saweekmusic/wordsearch
Author: Sviatoslav Trofymenko
Author-email: sviatoslavtrofymenko@icloud.com
License: MIT
Project-URL: Bug Tracker, https://github.com/saweekmusic/wordsearch/issues
Classifier: Programming Language :: Python :: 3
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Requires-Python: >=3.7
Description-Content-Type: text/markdown
License-File: LICENSE
Dynamic: author
Dynamic: author-email
Dynamic: classifier
Dynamic: description
Dynamic: description-content-type
Dynamic: home-page
Dynamic: license
Dynamic: license-file
Dynamic: project-url
Dynamic: requires-python
Dynamic: summary

# WordSearch Generator

A simple word search puzzle generator in Python.  
Supports horizontal, vertical, and diagonal word placements.  
Returns a clean 2D array that you can further customize and display however you like.

---

## 🚀 Features

- Automatically fits all words into a square grid
- Supports custom languages (via `alphabets.py`)
- Places words in:
  - Horizontal ↔️
  - Vertical ↕️
  - Diagonal ↘️ directions
- Returns a ready-to-use 2D array (no output to file or console by default)

---

## 🧪 Example

```python
from wordsearch import WordSearch
from alphabets import Alphabets

words = ["painter", "back", "board", "cactus", "reliance"]
ws = WordSearch(words, language=Alphabets.ENGLISH)

for row in ws.grid:
    print(" ".join(row))
```

Output: *(will vary due to randomness)*

```
P A I N T E R S E T
C R A N G E M A I P
...
```

---

## 🧠 Customization

Want to use different alphabets?  
Check out `alphabets.py` to define your own language set.  
You can pass it like so:

```python
ws = WordSearch(words, language=Alphabets.SPANISH)
```

---

## 🤓 Who is this for?

- Educators making worksheets
- Devs wanting to visualize word data
- Puzzle nerds (you know who you are)

---

## 📋 License

MIT — feel free to use, modify, and share.  
If you build something fun with it, let me know! 😄

