Literate wordle

Welcome! Browse the table of content to inspect this short project’s documentation.

Remember to have a look at the project’s codebase in https://github.com/OverkillGuy/literate-wordle, and my personal blog where I host this page: https://jiby.tech/

Table of Contents:

• Readme
  • Dependencies
  • Literate programming?
  • Usage
    • Read the story
    • Play the game
    • Reuse the python module
  • Development
    • Python setup
    • Documentation
  • License
• Literate programming wordle
• Source of Literate Wordle
• Changelog
  • [Unreleased]
  • [1.1.1] - 2022-06-27
    • Fixed
  • [1.1.0] - 2022-06-13
    • Fixed
    • Added
  • [1.0.2] - 2022-05-08
    • Fixed
  • [1.0.1] - 2022-05-07
    • Added
    • Fixed
  • [1.0.0] - 2022-05-06
    • Added
• Requirements
  • List of requirements
    • command_line_entrypoint.feature
    • track_guesses.feature
    • checking_guess_valid_word.feature
    • pick_answer_word.feature
    • scoring_guess.feature
  • Requirements summary
• API Reference
  • literate_wordle
    • Subpackages
      • literate_wordle.assets
    • Submodules
      • literate_wordle.cli
        • Module Contents
          • Functions
            • parse_args
            • play_game_args
            • main
      • literate_wordle.game
        • Module Contents
          • Classes
          • Functions
            • WordleMoveOutcome
              • GAME_OVER_LOST
              • GAME_WON
              • GUESS_SCORED_CONTINUE
              • GUESS_NOTVALID_CONTINUE
            • WordleGame
              • answer
              • guess_number
            • WordleMove
              • game
              • outcome
              • message
              • score
            • play_round
      • literate_wordle.guess
        • Module Contents
          • Classes
          • Functions
            • CharacterScore
              • OK
              • NO
              • WRONG_PLACE
              • perfect_score
            • score_guess
      • literate_wordle.main
        • Module Contents
          • Functions
            • new_game
            • play_game
      • literate_wordle.words
        • Module Contents
          • Functions
          • Attributes
            • ANSWERS_FILENAME
            • ACCEPTED_FILENAME
            • get_answers
            • get_accepted_words
            • get_asset_zip_as_set
            • pick_answer_word
            • check_valid_word
  • tests
    • Submodules
      • tests.test_checking_guess_valid_word
        • Module Contents
          • Functions
            • test_reject_long_words
            • test_reject_overly_short_words
            • test_reject_nondict_words
            • test_accept_dict_words
      • tests.test_pick_word
        • Module Contents
          • Functions
            • test_pick_word_ok_length
      • tests.test_scoring_guess
        • Module Contents
          • Functions
            • test_perfect_guess
            • test_no_common_character
            • test_wrong_place
            • test_generic_score
      • tests.test_track_guess_number
        • Module Contents
          • Functions
            • test_first_guess_allowed
            • test_sixth_guess_allowed
            • test_seventh_guess_fails_game
            • test_winning_guess_wins
            • test_invalid_guess_not_counted