Table of Contents

• Overview
• Features
• Project Structure
  • Project Index
• Getting Started
  • Prerequisites
  • Installation

---

Overview

Some word game-related tools, including a complete and functional Wordament Solver that can handle all special tiles (please RTFM first though). Was originally a different Wordament solver I made that had a very shitty OCR component, but that has been deprecated for being, well, shit.

---

Features

Two Trie-based solutions - a Wordament solver and a general Un-scrambler/Scrabble rack solver/anagrammer tool. Both GUI, made with customtkinter.

---

Project Structure

└── grammarpuss/
    ├── Pipfile
    ├── Pipfile.lock
    ├── README.md
    ├── anagrams.py
    ├── assets
    │   └── wordament_dictionary.txt
    └── wordup.py

Getting Started

Prerequisites

Before getting started with grammarpuss, ensure your runtime environment meets the following requirements:

• Programming Language: Python ^3.10
• Package Manager: Pipenv for venv management and dependencies. Pipfile and lock included (or just pip install yourself, or just handle it manually since the depends are very minimal).

Installation

Install grammarpuss using one of the following methods:

Build from source:

1. Clone the grammarpuss repository:

❯ git clone https://github.com/nannerpusser/grammarpuss

2. Navigate to the project directory:

❯ cd grammarpuss

3. Install the project dependencies:

Using pipenv  

❯ pipenv install

Usage

Run grammarpuss using the following command: Using pipenv  

❯ pipenv shell
❯ python wordup.py

---

Project Roadmap

• lol, yeah right.

---

Contributing

• 💬 Join the Discussions: Share your insights, provide feedback, or ask questions.
• 🐛 Report Issues: Submit bugs found or log feature requests for the grammarpuss project.

---

License

This project is protected under the SELECT-A-LICENSE License. For more details, refer to the LICENSE file.

---

Acknowledgments

• List any resources, contributors, inspiration, etc. here.

---