New individual guesses and guess logging feature. Version 2.2.0.

Author: preritdas

README.md

@@ -5,6 +5,36 @@ View on [GitHub](https://github.com/preritdas/wordle) and [PyPI](https://pypi.or
 ----
 ## Updates
 
+### Version 2.2.0: Individual Guessing!
+
+This package can now be properly used to power the backend of a Wordle game. Initially, the `.run()` method had to be used to play the game. It would open a console, request guesses as inputs, and print out responses. That's not a viable solution to power the backend of a package user's application or game. 
+
+The `Wordle` class has two new submethods: `.send_guess()` and `.reset_guesses()`. 
+
+Instantiate an object with the answer and game options (dictionary, etc.). Then, send individual guesses and the method will return a response.
+
+```python
+import wordle
+
+# Instantiate a game object
+game = wordle.Wordle(word = 'grape', real_words = True)
+
+# Send your object a guess
+response = game.send_guess('adieu')
+# response = a d i e u
+
+# Send an invalid guess
+response = game.send_guess('yabadabadoo')
+# response = "You can't guess a word with more than 5 letters."
+# Note: invalid guesses don't count towards the guess log.
+
+# Send a 7th guess (only 6 allowed with log_guess = True)
+response = game.send_guess('seven')
+# response = "Out of guesses."
+```
+
+More information on how to use this new feature is below.
+
 ### Version 2.0.0
 
 A new function to get a random answer based on the day. You can deploy this Wordle and have it give you a random answer automatically every day! Instead of manually changing the answer, the program (can) automatically change its answer every day.
@@ -108,4 +138,10 @@ import wordle
 if __name__ == "__main__":
     print(wordle.Wordle.__doc__)
     print(wordle.Wordle.run.__doc__)
-```
+```
+
+### Individual Guessing
+
+This new feature was introduced in the Version 2.2.0 update at the top of the read-me. Here's some more usage information.
+
+The `.send_guess()` method has two parameters, one of which is optional. `guess` is a string and is necessary. `log_guess` is a boolean and is `True` by default. Log guessing is simply the program's way of tracking how many times a _valid_ guess has been sent to the object. It will only allow 6 valid guesses to be sent to it before it starts returning `"Out of guesses."` automatically. To send a guess and return a response without adding to the guesses log, use `log_guess = False`.

dist/wordle-python-2.1.4.tar.gz

@@ -1,6 +1,6 @@
 from setuptools import setup, find_packages
 
-VERSION = "2.1.4"
+VERSION = "2.2.0"
 DESCRIPTION = (
     "The popular word game recreated in Python, deployable with custom answers."
 )

dist/wordle-python-2.2.0.tar.gz

@@ -1,3 +1,27 @@
 import wordle
 
-wordle.Wordle(random_daily = True).run()
+game = wordle.Wordle(word = 'grape', real_words = True)
+
+response = game.send_guess(guess = 'adieu')
+print(response)
+
+response = game.send_guess(guess = 'adieu')
+print(response)
+
+response = game.send_guess(guess = 'adieu')
+print(response)
+
+response = game.send_guess(guess = 'adieu')
+print(response)
+
+response = game.send_guess(guess = 'adieu')
+print(response)
+
+response = game.send_guess(guess = 'adieu')
+print(response)
+
+response = game.send_guess(guess = 'adieu')
+print(response)
+
+# as there are seven sent attempts, the final one returns...
+#... "Out of guesses." as expected.

dist/wordle_python-2.1.4-py3-none-any.whl renamed to dist/wordle_python-2.2.0-py3-none-any.whl

@@ -9,6 +9,9 @@ def __init__(self, word: str = 'hello', real_words: bool = True, random_daily: b
         if random_daily == True:
             self.word = randomanswer.random_answer(daily=True).upper()
 
+        # Individual guesses
+        self.individual_guesses = []
+
     def run(self):
         """Run the game. Depends on bool real_words from instantiation."""
 
@@ -94,4 +97,89 @@ def run(self):
                     raise Exception("Fatal iteration error for largest for loop.")
                 quit()
         print("You failed.")
-        quit()
+        quit()
+
+    # Individual guesses
+    def send_guess(self, guess: str, log_guess: bool = True):
+        """
+        Send individual guesses. Returns a tuple where item one is the \
+            string response, and item two is a boolean of whether or not the \
+            puzzle was solved.. 
+        Follows dictionary checking if that's enabled on object instantiation.
+        If a guess is invalid (too many letters, etc.) the returned response \
+            is simply an error message. No guess is logged.
+        Use log_guess = False to send a guess without it counting towards \
+            the 6 guess total.
+        """
+        # For duplicate checking
+        self.word_dup = list(self.word)
+        failed_dictionary_test = False # by default
+
+        # Cheating checks
+
+        # real_words = True
+        if self.real_words == True and guess.lower() not in dictionary.words:
+            failed_dictionary_test = True
+
+        while (
+            failed_dictionary_test == True
+            or " " in guess
+            or len(guess) > len(self.word)
+        ):
+            if " " in guess:
+                return "You can't have multiple words in your guess."
+            elif len(guess) > len(self.word):
+                return f"You can't guess a word with more than {len(list(self.word))} letters."
+            elif failed_dictionary_test == True: # Not a real word
+                return "That's not a real word."
+
+            # Correct failed dictionary test if real word is guessed
+            if guess.lower() in dictionary.words:
+                failed_dictionary_test = False
+
+        # prepare response list
+        response = ['', '', '', '', '']
+
+        # first correctness check
+        for j in range(len(guess)):
+            if guess[j] in self.word_dup and guess[j] == self.word[j]:
+                response[j] = f"*{guess[j]}*   "
+                self.word_dup.remove(guess[j])  # Duplicates
+
+        # next present and absent check
+        for j in range(len(guess)):
+            # already response skip
+            if response[j] != "":
+                continue
+            # it's present(yellow)
+            if guess[j] in self.word_dup:
+                response[j] = guess[j] + "   "
+                self.word_dup.remove(guess[j])  # Duplicates
+            # other absent
+            else:
+                response[j] = guess[j].lower() + "   "
+
+        responseString = ""
+        for letter in response:
+            responseString += letter
+
+        if guess == self.word:
+            guessed_correctly = True
+
+        # Guess Logging
+        if log_guess:
+            if len(self.individual_guesses) < 6:
+                self.individual_guesses.append(guess)
+            else:
+                return "Out of guesses."
+
+        # Return the response
+        if guessed_correctly:
+            return responseString, True
+        else:
+            return responseString, False
+
+    # Reset individual guesses
+    def reset_guesses(self):
+        """Removes all guesses from guess logging to allow 6 more attempts."""
+        self.individual_guesses = []