Metadata-Version: 2.1
Name: lbsolver
Version: 0.9.0
Summary: A package containing a solver for the NYT Letter Boxed Game
Author: Derik Pack
License: MIT License
        
        Copyright (c) 2022 packdl
        
        Permission is hereby granted, free of charge, to any person obtaining a copy
        of this software and associated documentation files (the "Software"), to deal
        in the Software without restriction, including without limitation the rights
        to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
        copies of the Software, and to permit persons to whom the Software is
        furnished to do so, subject to the following conditions:
        
        The above copyright notice and this permission notice shall be included in all
        copies or substantial portions of the Software.
        
        THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
        IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
        FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
        AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
        LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
        OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
        SOFTWARE.
        
Project-URL: Homepage, https://github.com/packdl/letter-boxed-solver
Project-URL: API Documentation, https://packdl.github.io/letter-boxed-solver/
Classifier: Programming Language :: Python :: 3
Classifier: License :: OSI Approved :: MIT License
Classifier: Development Status :: 4 - Beta
Requires-Python: >=3.9
Description-Content-Type: text/markdown
Provides-Extra: dev
License-File: LICENSE

# 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.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)


