Skip to content

JeMaNd-r/scrabble_help

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

20 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Scrabble help app

This application provides suggestions for most-scoring words based on a given set of letters.

This project may also serve as inspiration, because it is a #good-first-project to learn Python3 :)

Getting Started

Download the repository and run the app.py file using a terminal in VS Code or a command line interpreter (e.g. CMD). You will be asked to provide the letters without deliminator. Afterwards, the top 5 words scoring most points will be shown with their score. The score is based on the Scrabble scoring system.

Prerequisites

  • Python 3.14.5

Following Python libraries are used:

  • time (to pause execution)
  • json (save and read JSON files to store word list)

Additionally, following Python libraries are used for data preparation:

  • pypdf-6.13.3 (load and extract text from PDF)
  • re (extract string pattern)

Installing

Install the required Python version. Then, install the required Python packages (e.g., using py -m pip install [package] in the command line).

When running py app.py in the project directory, the programm should run and wait for the user input (i.e., letters)

If you plan to also run the prepare_data.py, please make sure to download the/a PDF with words first (see Acknowledgements).

Running the tests

You can test if you installed the correct Python version using py --version. You correct Python version might be also accessible using python or python3 instead of py.

Contributing

This is a personal learning project and is not open to contributions. Thank you for your understanding.

Versioning

Potential updates:

  • add tests for input letters, e.g. digits or too few letters
  • extend word list to longer words
  • allow users to correct the scoring system
  • allow users to insert which position(s) in the word can get doubled or tripled points, or make the whole word count doubled or tripled
  • provide leftover letters if choosing one of the top 5 words

Author

  • Romy Zeiss

License

This project is licensed under the CC0 1.0 Universal Creative Commons License - see the LICENSE.md file for details

Acknowledgments

The list of German Scrabble words was extracted here from the scrabble-info.de website. It does not contain a complete list of Scrabble words, but it does serve the purpose of this simple app, as the app should support finding words.

The code to read and extract text from PDF was based on the tutorial from Geeks for Geeks here and here.

About

Application to provide suggestions for most-scoring words in Scrabble based on a given set of letters

Topics

Resources

License

Stars

0 stars

Watchers

0 watching

Forks

Releases

No releases published

Packages

 
 
 

Contributors

Languages