semvec/pypi-packages huggingface dataset:
lbsolver 1.0.0
A package containing a solver for the NYT Letter Boxed Game
License: MIT License
Requires Python: >=3.9

# Introduction
![Python tests](https://github.com/packdl/letter-boxed-solver/actions/workflows/python-package.yml/badge.svg) ![Pages site](https://github.com/packdl/letter-boxed-solver/actions/workflows/sphinx.yml/badge.svg) ![Code scanning](https://github.com/packdl/letter-boxed-solver/actions/workflows/codeql.yml/badge.svg)

This is a simple script to solve the [NYT Letter Boxed game](https://www.nytimes.com/puzzles/letter-boxed). The user supplies a words file and a Letter Boxed gamehe words file is used to generate winning combinations for Letter Boxed. 

Good recommendations for words files include:
- The [words](https://en.wikipedia.org/wiki/Words_(Unix)) file included with Linux
- The Moby II projects [common](https://www.gutenberg.org/files/3201/files/COMMON.TXT) words file

# Installation
1. Clone the repo
2. Create a virtual environment
3. Open a terminal and cd into the cloned directory 
4. Type: 'python -m pip install -e .' to create an editable install

# Usage
## Using an example on a Python REPL in Linux
```
from lbsolver import Gameboard, LBSolver
board = Gameboard("t n m h r v i k e a u b".split())
FILE = '/usr/share/dict/words'
with open(FILE,'r') as my_file:
    dictionary = my_file.readlines()


solver = LBSolver(board, dictionary)
answers = solver.solve(max_num_words=3, minimum_answers=10)
print(answers)
```
## Command line
Type the following at the command prompt to see command line usage:
```
lbsolver -h
```
# The API
[A simple API](https://packdl.github.io/letter-boxed-solver)
# Our License
- [Our License](https://choosealicense.com/licenses/mit/)
- test_dictionary [license](http://changelogs.ubuntu.com/changelogs/pool/main/s/scowl/scowl_2020.12.07-2/copyright)