- Fixed docstring spelling errors

- Other small docstring adjustments
- Added more decryption tests
- Added docstring to test class
- Improved existing test method docstrings
- Improved "./README.md"
- Changes to "./setup.py"
- Removed unused import from "./__init__.py"
- Small changes to encryption method output text

Signed-off-by: schlopp96 <[email protected]>

Author: schlopp96

MyCaesarCipher/__init__.py

@@ -1 +0,0 @@
-from .main import CaesarCipher

MyCaesarCipher/main.py

@@ -3,9 +3,11 @@
 from random import randint
 from typing import Optional
 
+__version__ = '0.4.0'
+
 
 class CaesarCipher:
-    """Cryptographic encryption/decryption techniques using the Caesar-Cipher algorithm.
+    """Cryptographic encryption/decryption using the Caesar-Cipher algorithm.
 
     ---
 
@@ -21,7 +23,7 @@ class CaesarCipher:
     def encrypt(text: str,
                 key: Optional[int] = None,
                 stdout_output: bool = True) -> str:
-        """Encrypt text using the Caesar-Cypher cryptography algorithm.
+        """Encrypt text using the Caesar-Cipher cryptography algorithm.
 
         - Generates encrypted form of :param:`text` using the Caesar-Cipher algorithm.
         - If no :param:`key` is provided, a random integer value is generated.
@@ -64,7 +66,7 @@ def encrypt(text: str,
             else:
                 output += char
 
-        info: str = f'> Original Msg : {text}\n\n> Shift-key : {key}\n\n> Encrypted Result: {output}\n'
+        info: str = f'> Original Txt : {text}\n\n> Shift-key : {key}\n\n> Encrypted Result: {output}\n'
 
         if stdout_output:
             print(info)

MyCaesarCipher/tests/MyCaesarCipher_Test.py

@@ -3,6 +3,20 @@
 
 
 class CaesarCipherTesting:
+    """Provides methods for testing the encryption and decryption functionality of the `CaesarCipher` class.
+
+    ---
+
+    Contains the following test methods:
+
+        - :func:`test_encrypt(self, text: str, key: int, assertion: str, output_results: bool = True) -> None`
+            - Test encryption process using given text and shift-key.
+            - Output of test results to stdout enabled by default.
+
+        - :func:`test_decrypt(self, text: str, assertion: str, output_results: bool = True) -> None`
+            - Test decryption method using given text.
+            - Output of test results to stdout enabled by default.
+    """
 
     def __init__(self, test_class=CaesarCipher()) -> None:
         self.test_class: Any = test_class
@@ -15,8 +29,9 @@ def test_encrypt(
         output_results: bool = True,
     ) -> None:
         """
-        Tests encryption of given text and shift-key and asserts the result
-        is equal to the output.
+        Test encryption method using given text and shift-key.
+
+        ---
 
         :param text: text to encrypt
         :type text: :class:`str`
@@ -25,58 +40,75 @@ def test_encrypt(
         :param assertion: expected output of the encryption
         :type assertion: :class:`str`
         :param output_results: toggle result output, defaults to :bool:`True`
-        :type output_results: :class:`bool` (optional)
+        :type output_results: :class:`bool`, optional
+        :return: result of encryption test
+        :rtype: None
         """
 
         assert self.test_class.encrypt(text, key, output_results) == assertion
 
     def test_decrypt(self,
                      text: str,
                      assertion: str,
-                     output_results: bool = False) -> None:
+                     output_results: bool = True) -> None:
         """
-        Tests decryption of given text and whether the assertion can be found within resulting output.
+        Test decryption method using given text.
 
         ---
 
-        :param text: the text to be decrypted
+        :param text: text to be decrypted
         :type text: :class:`str`
         :param assertion: expected result to be found within output
         :type assertion: :class:`str`
         :param output_results: toggle output of results to `stdout`, defaults to `False`
-        :type output_results: :class:`bool` (optional)
+        :type output_results: :class:`bool`, optional
+        :return: result of decryption test
+        :rtype: None
         """
 
         assert assertion in self.test_class.decrypt(text, output_results)
 
 
-# Create test class instance.
+# Create test class instance
 testCC: CaesarCipherTesting = CaesarCipherTesting()
 
 
-# Test encryption of string containing 5 uppercase characters.
+# Test encryption of string containing uppercase characters
 def test_encodeA() -> None:
     testCC.test_encrypt('TESTING', 5, 'YJXYNSL')
 
 
-# Test encryption of string containing both lowercase and uppercase characters.
+# Test encryption of string containing both lowercase and uppercase characters
 def test_encodeB() -> None:
     testCC.test_encrypt("TeStInG", 5, 'YjXyNsL')
 
 
-# Test encryption of string containing digits.
+# Test encryption of string containing digits
 def test_encodeC() -> None:
     testCC.test_encrypt('16', 5, '61')
 
 
-# Test encryption of string containing lowercase/uppercase characters and digits.
+# Test encryption of string containing lowercase/uppercase characters and digits
 def test_encodeD() -> None:
     testCC.test_encrypt("Password123", 5, 'Ufxxbtwi678', False)
 
 
+# Test decryption of string containing lowercase characters
 def test_decodeA() -> None:
-    testCC.test_decrypt('1djjktcqttccwprztsd', '0syyzirfiirrlegoihs')
+    testCC.test_decrypt('djjktcqttccwprztsd', 'syyzirfiirrlegoihs')
 
 
+# Test decryption of string containing lowercase/uppercase characters and digits
 def test_decodeB() -> None:
-    testCC.test_decrypt('2ekkludruuddxosaute', '1djjktcqttccwnrztsd')
+    testCC.test_decrypt('2EkkLudRuuddXosaute123', '1DjjKtcQttccWnrztsd012')
+
+
+# Test decryption of string containing lowercase/uppercase characters and punctuation
+def test_decodeC() -> None:
+    testCC.test_decrypt('Szh\'d te rztyr? Hlye ez slyr zfe zc dzxpestyr?',
+                        'How\'s it going? Want to hang out or something?')
+
+
+# Test decryption of string containing lowercase/uppercase characters, numbers and punctuation
+def test_decodeD() -> None:
+    testCC.test_decrypt('3120854 - Idbbn Ijidct', '8675309 - Tommy Tutone')

README.md

@@ -10,23 +10,24 @@
 
   - Each letter in the plaintext entry is replaced by a letter found at a certain number of positions down the alphabet.
 
-- This project was created as an exercise while I was taking the ["Cracking Codes with Python"](https://inventwithpython.com/cracking/) course - which I _highly_ recommend for both beginners and experienced python programmers interested in cryptography!
+- This project was created as an exercise while I was taking the ["Cracking Codes with Python"](https://inventwithpython.com/cracking/) course - which I _highly_ recommend for both beginners and experienced Python programmers interested in cryptography!
 
 ---
 
 ## Installation
 
 ### Using pip _(Recommended)_
 
-> _Easiest_ method. _**Highly recommended over manual installation.**_
+> **_Easiest_ method.**
+> _Highly recommended over manual installation._
 
 - Run the following to install _**`MyCaesarCipher`**_ using `pip`:
 
   - ```python
     pip install MyCaesarCipher
     ```
 
-- You should now be able to import/run _**`MyCaesarCipher`**_ within your python environment by entering the following:
+- You should now be able to import/run _**`MyCaesarCipher`**_ within your Python environment by entering the following:
 
   - ```python
     >>> from MyCaesarCipher import CaesarCipher
@@ -39,14 +40,15 @@
 
 ### Manual Installation
 
-> _Not_ recommended. _**Only use this method if you are unable to use `pip`**_.
+> **_Not_ recommended.**
+> _Only use this method if you are unable to install using `pip`_.
 
 1. Before use, navigate to the intended installation location, and create a new directory.
 
 2. Please only do one of the following:
 
     - **A.** Clone repository with the git client of your preference.
-    - **B.** Download and extract the source code `zip` archive from the ["[releases"](https://github.com/schlopp96/MyCaesarCipher/releases) page to the newly created directory.
+    - **B.** Download and extract the source code `zip` archive from the ["releases"](https://github.com/schlopp96/MyCaesarCipher/releases) page to the newly created directory.
 
 3. Install all dependencies for this package within the installation directory using the following command:
 
@@ -64,29 +66,29 @@
 
 - Within a Python environment or **`.py`** project, simply import the _**`MyCaesarCipher`**_ module to start encryption/decryption of ciphers.
 
-### Message Encryption
+### Text Encryption
 
 - For encrypting text, use the **`CaesarCipher.encrypt`** class method:
 
   - ```python
     >>> from MyCaesarCipher import CaesarCipher
 
     >>> cipher = CaesarCipher() # Create new class instance.
-    >>> msg = 'Test Cipher'
-    >>> cipher.encrypt(text=msg, key=200, stdout_output=True)
+    >>> txt = 'Test Cipher'
+    >>> cipher.encrypt(text=txt, key=15, stdout_output=True)
 
     ------------------------------------
 
-    > Original Msg : Test Cipher
+    > Original Txt : Test Cipher
 
-    > Shift-Key : 200
+    > Shift-Key : 15
 
-    > Encrypted Result: Lwkl Uahzwj
+    > Encrypted Result: Ithi Rxewtg
     ```
 
-- Therefore the final encrypted result of "Test Cipher" using a shift key of 200 is:
+- Therefore the final encrypted result of "Test Cipher" using a shift key of 15 is:
 
-  - "**`LwklfUahzwj`**".
+  - "**`Ithi Rxewtg`**".
 
 - Note that the `key` parameter is _optional_, and if not provided, a random key between 1 and 25 will be generated:
 
@@ -95,7 +97,7 @@
 
     ------------------------------------
 
-    > Original Msg : Test Cipher
+    > Original Txt : Test Cipher
 
     > Shift-key : 19
 
@@ -109,7 +111,7 @@
 
     ------------------------------------
 
-    > Original Msg : Test Cipher
+    > Original Txt : Test Cipher
 
     > Shift-key : 24
 
@@ -123,7 +125,7 @@
 
     ------------------------------------
 
-    > Original Msg : Test Cipher
+    > Original Txt : Test Cipher
 
     > Shift-key : 4
 
@@ -132,7 +134,7 @@
 
 ---
 
-### Message Decryption
+### Text Decryption
 
 - For decrypting text, use the **`CaesarCipher.decrypt`** class method:
 
@@ -195,16 +197,19 @@
     > Decrypted Shift-Key 24 : Qbpq Zfmebo
 
     > Decrypted Shift-Key 25 : Paop Yeldan
+    ```
+
+- The **`CaesarCipher.decrypt`** method will return all possible shifted-key variations of the given encrypted text as a dictionary.
+  - This is NOT printed to stdout even if the `stdout_output` parameter is set to `True`.
 
+  - ```python
     {'Ozno Xdkczm': 0, 'Nymn Wcjbyl': 1, 'Mxlm Vbiaxk': 2, 'Lwkl Uahzwj': 3, 'Kvjk Tzgyvi': 4, 'Juij Syfxuh': 5, 'Ithi Rxewtg': 6, 'Hsgh Qwdvsf': 7, 'Grfg Pvcure': 8, 'Fqef Oubtqd': 9, 'Epde Ntaspc': 10, 'Docd Mszrob': 11, 'Cnbc Lryqna': 12, 'Bmab Kqxpmz': 13, 'Alza Jpwoly': 14, 'Zkyz Iovnkx': 15, 'Yjxy Hnumjw': 16, 'Xiwx Gmtliv': 17, 'Whvw Flskhu': 18, 'Vguv Ekrjgt': 19, 'Uftu Djqifs': 20, 'Test Cipher': 21, 'Sdrs Bhogdq': 22, 'Rcqr Agnfcp': 23, 'Qbpq Zfmebo': 24, 'Paop Yeldan': 25}
     ```
 
-- The **`CaesarCipher.decrypt`** method will return all possible shifted-key variations of the given encrypted message as a dictionary.
-
-- **_Generally_**, the _most legible_ key output will be the correct decrypted message, assuming the encrypted message was legible initially.
+- **_Generally_**, the _most legible_ key output will be the correct decrypted text (assuming the encrypted text was legible initially).
 
-- Regardless, the correct output **MUST** be one of the output values due to the limitations of the algorithm being tied to the length of the alphabet 26 and the number of possible integers [0-9].
-  - This is also the reason why the algorithm is not recommended for serious real-world cryptography use cases.
+- Regardless, the correct output **MUST** be one of the output values due to the limitations of the algorithm being tied to the length of the alphabet [26] and the number of possible integers [0-9].
+  - This is also the reason why the algorithm is not recommended for serious real-world cryptography use cases, as it is rather simple to decipher Caesar-Cipher encrypted text.
 
 ---
 

setup.py

@@ -4,7 +4,7 @@
 readme = pathlib.Path("readme.md").read_text()
 reqs = pathlib.Path("requirements.txt").read_text()
 setup(name="MyCaesarCipher",
-      version="0.3.0",
+      version='0.4.0',
       description=
       'Simple cryptographic substitution-based cipher for encoding plaintext.',
       url='https://github.com/schlopp96/MyCaesarCipher',
@@ -32,5 +32,6 @@
       ],
       keywords=[
           'cryptography', 'Caesar-Cipher', 'Caesar', 'Cipher', 'encryption',
-          'decryption', 'cryptographic', 'module', 'script', 'python'
+          'decryption', 'cryptographic', 'module', 'script', 'encrypt',
+          'decrypt', 'python'
       ])