Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/nannerpusser/grammarpuss
Wordament solver + anagramming tool (both Trie-based).
https://github.com/nannerpusser/grammarpuss
anagrammer customtkinterprojects wordament
Last synced: about 1 month ago
JSON representation
Wordament solver + anagramming tool (both Trie-based).
- Host: GitHub
- URL: https://github.com/nannerpusser/grammarpuss
- Owner: nannerpusser
- Created: 2024-11-10T01:55:09.000Z (about 1 month ago)
- Default Branch: main
- Last Pushed: 2024-11-10T01:59:00.000Z (about 1 month ago)
- Last Synced: 2024-11-10T02:30:16.735Z (about 1 month ago)
- Topics: anagrammer, customtkinterprojects, wordament
- Language: Python
- Homepage:
- Size: 0 Bytes
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
## Table of Contents
- [ Overview](#-overview)
- [ Features](#-features)
- [ Project Structure](#-project-structure)
- [ Project Index](#-project-index)
- [ Getting Started](#-getting-started)
- [ Prerequisites](#-prerequisites)
- [ Installation](#-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
```sh
└── 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:
```sh
❯ cd grammarpuss
```
3. Install the project dependencies:
**Using `pipenv`** [
](https://pipenv.pypa.io/)
```sh
❯ pipenv install
```
### Usage
Run grammarpuss using the following command:
**Using `pipenv`** [](https://pipenv.pypa.io/)
```sh
❯ pipenv shell
❯ python wordup.py
```
---
## Project Roadmap
- lol, yeah right.
---
## Contributing
- **💬 [Join the Discussions](https://github.com/nannerpusser/grammarpuss/discussions)**: Share your insights, provide feedback, or ask questions.
- **🐛 [Report Issues](https://github.com/nannerpusser/grammarpuss/issues)**: Submit bugs found or log feature requests for the `grammarpuss` project.
---
## License
This project is protected under the [SELECT-A-LICENSE](https://choosealicense.com/licenses) License. For more details, refer to the [LICENSE](https://choosealicense.com/licenses/) file.
---
## Acknowledgments
- List any resources, contributors, inspiration, etc. here.
---