Skip to main content

Wordle -- Game, Solver and Helper!

Project description

https://img.shields.io/pypi/v/python-wordle?color=success Documentation Status Python Version Support GitHub Issues GitHub Followers Twitter Followers

Wordle – Game, Solver and Helper!

Features

  • Comprehensive CLI Application
    • Play Wordle in your terminal!

    • Let the solver play it out for you!

    • Use the helper mode for solving Wordles provided by other platforms!

  • New Wordle every day.
    • Disclaimer: This has nothing to do with the NYTimes Wordle.

  • Play more using --random option.

  • Reproducible random Wordle by specifying --seed.

  • WordleSolver() class for solving Wordle.

  • --solve option to let WordleSolver() do its work in front of your eyes!

  • --helper option to activate the helper mode for help with solving Wordles provided by other platforms.

Install

To install, run this command in your terminal:

$ pip install python-wordle

Usage

usage: wordle [-h] [--random] [--seed SEED] [--solve] [--helper]

Wordle on your terminal

optional arguments:
-h, --help   show this help message and exit
--random     Show a random Wordle
--seed SEED  Seed the RNG
--solve      Simulate WordleSolver
--helper     Take help from WordleSolver for a Wordle in a different platform

Example

screenshot.png

Helper Session

Attempt 1
=========

Suggestions: [('kioea', 95.7343887423043)]
Chosen word: aeons
Obtained result: 01201
Eliminated 15868 options.

Attempt 2
=========

Suggestions: [('thrip', 78.0), ('thirl', 78.0)]
Chosen word: thrip
Obtained result: 00000
Eliminated 39 options.

Attempt 3
=========

Suggestions: [('blayk', 72.72727272727273), ('milky', 72.72727272727273), ('bulky', 72.72727272727273), ('lucky', 72.72727272727273), ('mckay', 72.72727272727273)]
Chosen word: milky
Obtained result: 10020
Eliminated 10 options.

Attempt 4
=========

Valid Words: {'smoke'}
Suggestions: [('smoke', 0.0)]
Chosen word: smoke
Obtained result: 22222

Congratulations!

Terminology

All of the following terms are valid in the context of a specific Wordle.

  • A set of known letters is a set of letters which are known to be present in the Wordle’s word based on clues obtained from the previous attempts.

  • A set of valid words at any given point refers to a set of words from vocabulary that are possible solutions to the Wordle at that point based on the clues obtained till then.

  • A letter is said to cover a word if the letter belongs to that word.

  • Coverage (absolute) of a word refers to the percentage of valid words (at that point) covered by the letters in that word.

  • Coverage (relative) of a word refers to the percentage of valid words (at that point) covered by the set of

Solver

Solver roughly uses the following strategy,

  • Guess a word with highest (relative) coverage.

  • After each guess, eliminate words based on the clues, e.g.,
    • Remove all words that contain an incorrect-letter

    • Remove all words that do not contain the identified (correct-letter, correct-position) combinations

    • Remove all words that contain the identified (correct-letter, incorrect-position) combinations

    • Remove all words that do not contain a correct-letter

    • Re-calculate (relative) coverage and guess again

  • If at any point, number of valid words drops below number of attempts left, guess the valid words one-by-one.

  • Additionally, there are heuristics to choose a word if multiple words with best coverage-score exist.

Helper

Helper mode can be used to get assistance while solving Wordle from another provider.

  • Suggestions for words will be provided at each step.

  • You may choose a word and obtain result.

  • Enter the obtained result as a ternary string, i.e., a string made of 0, 1, and 2.
    • 0 : (grey) : an incorrect letter.

    • 1 : (yellow) : a correct letter in wrong position.

    • 2 : (green) : a correct letter in correct position.

  • e.g., if the third letter turned green and fifth letter turned yellow in the third party Wordle, then you should input 00201 as the result obtained.

Evaluation

WordleSolver has been evaluated on the entire vocabulary.

Setup

  • Word Size: 5

  • Vocabulary Size: 15918

  • Maximum Attempts: 6

Performance

  • Success Count: 15446

  • Success Rate: 97.03 %

  • Average Attempts: 4.58

History

0.1.0 (2022-02-28)

  • First release on PyPI.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

python-wordle-0.1.4.tar.gz (1.9 MB view details)

Uploaded Source

Built Distribution

python_wordle-0.1.4-py2.py3-none-any.whl (1.8 MB view details)

Uploaded Python 2 Python 3

File details

Details for the file python-wordle-0.1.4.tar.gz.

File metadata

  • Download URL: python-wordle-0.1.4.tar.gz
  • Upload date:
  • Size: 1.9 MB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.4.1 importlib_metadata/3.10.1 pkginfo/1.5.0.1 requests/2.26.0 requests-toolbelt/0.9.1 tqdm/4.62.0 CPython/3.8.11

File hashes

Hashes for python-wordle-0.1.4.tar.gz
Algorithm Hash digest
SHA256 094e91f0101f7cd6372aab78b5dae80472a288da8dc3f4a5c184ccc7c1721a78
MD5 a10abdd72ce7d4ba8201c6beee54f19c
BLAKE2b-256 017422d93462f03aa5350ab57a9024a049a48f5df119c881c285f3d68bb7428c

See more details on using hashes here.

File details

Details for the file python_wordle-0.1.4-py2.py3-none-any.whl.

File metadata

  • Download URL: python_wordle-0.1.4-py2.py3-none-any.whl
  • Upload date:
  • Size: 1.8 MB
  • Tags: Python 2, Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.4.1 importlib_metadata/3.10.1 pkginfo/1.5.0.1 requests/2.26.0 requests-toolbelt/0.9.1 tqdm/4.62.0 CPython/3.8.11

File hashes

Hashes for python_wordle-0.1.4-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 2d60ab2f48ddd5144dc646dbdba46ee59beb9e7bf9801b6f8f38b080b8a230fb
MD5 f5d9cf67e85e29b7ccd490624fd6b6ba
BLAKE2b-256 f772ac977e5dfcdaad9e20766f7d5fe89d766eecca53941a595a1fab215d2c30

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page