enigmapython 1.3.0__tar.gz → 1.3.2__tar.gz

{enigmapython-1.3.0 → enigmapython-1.3.2}/PKG-INFO

@@ -1,32 +1,71 @@
 Metadata-Version: 2.4
 Name: enigmapython
-Version: 1.3.0
+Version: 1.3.2
 Summary: A simple yet faithful library to emulate different Enigma machines models using Python
 Home-page: https://github.com/denismaggior8/enigma-python
 Author: Denis Maggiorotto
+License: MIT
+Classifier: Programming Language :: Python :: 3
+Classifier: Operating System :: OS Independent
+Classifier: License :: OSI Approved :: MIT License
 Description-Content-Type: text/markdown
 Dynamic: author
+Dynamic: classifier
 Dynamic: description
 Dynamic: description-content-type
 Dynamic: home-page
+Dynamic: license
 Dynamic: summary
 
 # Enigma Python library
 
 <div class="img-container" style="text-align: center;"> 
-    <img src="img/logo.jpg" alt="drawing" width="200" />
+    <img src="https://raw.githubusercontent.com/denismaggior8/enigma-python/master/img/logo.jpg" alt="drawing" width="200" />
 </div>
 
 ## About
 
 Welcome to **enigmapython**, a Python package designed to emulate the legendary Enigma cryptographic machine used during World War II. **enigmapython** provides a faithful implementation of the Enigma machine, allowing users to explore and understand the workings of this historic device.
 
+This project is listed on [Wikipedia](https://en.wikipedia.org/wiki/List_of_Enigma_machine_simulators) as a globally recognized Enigma machine simulator, noted for its historical accuracy.
+
+<div class="img-container" style="text-align: center;"> 
+    <a href="https://en.wikipedia.org/wiki/List_of_Enigma_machine_simulators">
+        <img src="https://img.shields.io/badge/Wikipedia-List%20of%20Enigma%20machine%20simulators-white?style=for-the-badge&logo=wikipedia&logoColor=black" alt="Wikipedia">
+    </a>
+    <a href="https://pypi.org/project/enigmapython/">
+        <img src="https://img.shields.io/pypi/v/enigmapython?style=for-the-badge&logo=pypi&logoColor=white" alt="PyPI version">
+    </a>
+    <a href="https://pypi.org/project/enigmapython/">
+        <img src="https://img.shields.io/pypi/pyversions/enigmapython?style=for-the-badge&logo=python&logoColor=white" alt="Python versions">
+    </a>
+    <a href="https://pepy.tech/project/enigmapython">
+        <img src="https://img.shields.io/pepy/dt/enigmapython?style=for-the-badge&logo=pypi&logoColor=white" alt="Total Downloads">
+    </a>
+    <a href="https://github.com/denismaggior8/enigma-python">
+        <img src="https://img.shields.io/github/stars/denismaggior8/enigma-python?style=for-the-badge&logo=github&logoColor=white" alt="GitHub Stars">
+    </a>
+    <a href="https://github.com/denismaggior8/enigma-python">
+        <img src="https://img.shields.io/github/languages/code-size/denismaggior8/enigma-python?style=for-the-badge&logo=github&logoColor=white" alt="Code Size">
+    </a>
+    <a href="https://github.com/denismaggior8/enigma-python/blob/master/LICENSE">
+        <img src="https://img.shields.io/github/license/denismaggior8/enigma-python?style=for-the-badge&logo=github&logoColor=white" alt="License">
+    </a>
+</div>
+
 ## Key Features
 
 - **Flexible Configuration**: **enigmapython** allows customization of the Enigma machine configuration, enabling users to experiment with different rotor settings, reflectors, and ring positions.
 - **Easy Extension**: **enigmapython** is designed to be easily extensible, allowing developers to add new features or enhance the existing implementation.
 - **Simple yet faithful**: don't be fooled by its simplicity; **enigmapython** implements 100% the algorithms of many Enigma machine models, allowing to decode a message that has been encoded by a real Enigma machine and also the contrary.
 
+## Historical Accuracy & Verification
+
+**enigmapython** is rigorously tested against authentic historical data to ensure maximum accuracy.
+
+
+- [Authentic German Army Test Message from 1930](https://cryptocellar.org/enigma/e-message-1930.html): Documented by Frode Weierud's CryptoCellar, this test validates that the **Enigma I** implementation correctly handles the complex interaction of rotors, ring settings, and plugboard connections exactly as the original machines did. See the [corresponding unit test](https://github.com/denismaggior8/enigma-python/blob/master/tests/Enigma1930_tests.py) for details.
+
 ## Machines implementations
 
 The following Enigma machine models (along with their rotors, reflectors and plugboards) have been implemented:
@@ -148,7 +187,7 @@ The following Enigma machine models (along with their rotors, reflectors and plu
 
 ## Getting started
 
-Please have a look of the [examples](https://github.com/denismaggior8/enigma-python/blob/master/examples/enigma_machines_examples.py) folder
+Get started by installing the package from PyPI (`pip install enigmapython`) and exploring the examples in the [examples](https://github.com/denismaggior8/enigma-python/tree/master/examples) folder.
 
 ## Documentation
 
@@ -161,16 +200,28 @@ Here's a list containing all the known Enigma simulators that use the **enigmapy
 - [Enigma TUI](https://github.com/denismaggior8/enigma-tui). **Enigma TUI** is a **T**erminal **U**ser **I**nterface for Enigma machines, allowing you to simulate different Enigma machine models from the terminal. It employs  **enigmapython** as Enigma engine. 
 
 <div class="img-container" style="text-align: center;"> 
-    <img src="img/enigmatui.png" alt="drawing" width="400" align="center"/>
+    <img src="https://raw.githubusercontent.com/denismaggior8/enigma-python/master/img/enigmatui.png" alt="drawing" width="400" align="center"/>
 </div>
+<br>
+<br>
 
+- [MicroPython Enigma Python](https://github.com/denismaggior8/micropython-enigma-python). **MicroPython Enigma Python** is a side project to bring Enigma Python library also on ambedded devices which runs MicroPython. It has been referenced on https://awesome-micropython.com/#historical, a curated list of the best MicroPython libraries, in the Cryptography/Historical section.
 
-- [Retrocampus BBS Enigma simulator](https://retrocampus.com/bbs/). When connected to the BBS, type E to access an Enigma M3 cypher machine whose backend is based on **enigmapython**.
+<div class="img-container" style="text-align: center;"> 
+    <img src="https://raw.githubusercontent.com/denismaggior8/enigma-python/master/img/micropython-enigma-python.png" alt="drawing" width="400" align="center"/>
+</div>
 
+<br>
+<br>
+
+- [Retrocampus BBS Enigma simulator](https://retrocampus.com/bbs/). When connected to the BBS, type E to access an Enigma M3 cypher machine whose backend is based on **enigmapython**.
 <div class="img-container" style="text-align: center;">
-    <img src="img/retrocampus_enigma.png" alt="drawing" width="400" align="center"/>
+    <img src="https://raw.githubusercontent.com/denismaggior8/enigma-python/master/img/retrocampus_enigma.png" alt="drawing" width="400" align="center"/>
 </div>
 
+<br>
+<br>
+
 In the case you leveraged **enigmapython** API in a project, either public or not, drop me an email at __denis.maggiorotto[at]gmail.com__ and I'll be happy to list you here.
 
 

{enigmapython-1.3.0 → enigmapython-1.3.2}/enigmapython/Enigma.py

@@ -16,18 +16,23 @@ class Enigma(Observer,Journaled,Clonable):
 
     alphabet_list = None
 
+    def add_rotor(self,idx,rotor):
+        if self.auto_increment_rotors == True and rotor is not None:
+            rotor.add_observer(self)
+        self.rotors[idx] = rotor
+
     def __init__(self, plugboard, rotors, reflector,etw,auto_increment_rotors=False, alphabet=Alphabets.lookup.get("latin_i18n_26chars_lowercase")):
         Journaled.__init__(self)
         Clonable.__init__(self)
         self.plugboard = plugboard
-        self.rotors = rotors
         self.reflector = reflector
+        self.rotors = [None]*len(rotors)
         self.etw = etw
         self.auto_increment_rotors = auto_increment_rotors
         self.alphabet_list = list(alphabet)
-        if auto_increment_rotors == True:
-            for rotor in rotors:
-                rotor.add_observer(self)
+        for i, rotor in enumerate(rotors):
+            self.add_rotor(i, rotor)
+        
 
     def input_string(self,str):
         output_string = ""

{enigmapython-1.3.0 → enigmapython-1.3.2}/enigmapython/Scrambler.py

@@ -51,7 +51,8 @@ class Scrambler(Journaled):
             i += 1
             # Rotate the wiring
             self.wiring = self.wiring[-1:] + self.wiring[:-1]
-            logging.debug("Rotation " + str(i).zfill(2) + "; Wiring: " + self.wiring)
+            # The following line has been commente out becode not Micropython compatible
+            # logging.debug("Rotation " + str(i).zfill(2) + "; Wiring: " + self.wiring)
          
     @staticmethod
     def __shift(letter, shift, alphabet_list):

{enigmapython-1.3.0 → enigmapython-1.3.2}/enigmapython.egg-info/PKG-INFO

@@ -1,32 +1,71 @@
 Metadata-Version: 2.4
 Name: enigmapython
-Version: 1.3.0
+Version: 1.3.2
 Summary: A simple yet faithful library to emulate different Enigma machines models using Python
 Home-page: https://github.com/denismaggior8/enigma-python
 Author: Denis Maggiorotto
+License: MIT
+Classifier: Programming Language :: Python :: 3
+Classifier: Operating System :: OS Independent
+Classifier: License :: OSI Approved :: MIT License
 Description-Content-Type: text/markdown
 Dynamic: author
+Dynamic: classifier
 Dynamic: description
 Dynamic: description-content-type
 Dynamic: home-page
+Dynamic: license
 Dynamic: summary
 
 # Enigma Python library
 
 <div class="img-container" style="text-align: center;"> 
-    <img src="img/logo.jpg" alt="drawing" width="200" />
+    <img src="https://raw.githubusercontent.com/denismaggior8/enigma-python/master/img/logo.jpg" alt="drawing" width="200" />
 </div>
 
 ## About
 
 Welcome to **enigmapython**, a Python package designed to emulate the legendary Enigma cryptographic machine used during World War II. **enigmapython** provides a faithful implementation of the Enigma machine, allowing users to explore and understand the workings of this historic device.
 
+This project is listed on [Wikipedia](https://en.wikipedia.org/wiki/List_of_Enigma_machine_simulators) as a globally recognized Enigma machine simulator, noted for its historical accuracy.
+
+<div class="img-container" style="text-align: center;"> 
+    <a href="https://en.wikipedia.org/wiki/List_of_Enigma_machine_simulators">
+        <img src="https://img.shields.io/badge/Wikipedia-List%20of%20Enigma%20machine%20simulators-white?style=for-the-badge&logo=wikipedia&logoColor=black" alt="Wikipedia">
+    </a>
+    <a href="https://pypi.org/project/enigmapython/">
+        <img src="https://img.shields.io/pypi/v/enigmapython?style=for-the-badge&logo=pypi&logoColor=white" alt="PyPI version">
+    </a>
+    <a href="https://pypi.org/project/enigmapython/">
+        <img src="https://img.shields.io/pypi/pyversions/enigmapython?style=for-the-badge&logo=python&logoColor=white" alt="Python versions">
+    </a>
+    <a href="https://pepy.tech/project/enigmapython">
+        <img src="https://img.shields.io/pepy/dt/enigmapython?style=for-the-badge&logo=pypi&logoColor=white" alt="Total Downloads">
+    </a>
+    <a href="https://github.com/denismaggior8/enigma-python">
+        <img src="https://img.shields.io/github/stars/denismaggior8/enigma-python?style=for-the-badge&logo=github&logoColor=white" alt="GitHub Stars">
+    </a>
+    <a href="https://github.com/denismaggior8/enigma-python">
+        <img src="https://img.shields.io/github/languages/code-size/denismaggior8/enigma-python?style=for-the-badge&logo=github&logoColor=white" alt="Code Size">
+    </a>
+    <a href="https://github.com/denismaggior8/enigma-python/blob/master/LICENSE">
+        <img src="https://img.shields.io/github/license/denismaggior8/enigma-python?style=for-the-badge&logo=github&logoColor=white" alt="License">
+    </a>
+</div>
+
 ## Key Features
 
 - **Flexible Configuration**: **enigmapython** allows customization of the Enigma machine configuration, enabling users to experiment with different rotor settings, reflectors, and ring positions.
 - **Easy Extension**: **enigmapython** is designed to be easily extensible, allowing developers to add new features or enhance the existing implementation.
 - **Simple yet faithful**: don't be fooled by its simplicity; **enigmapython** implements 100% the algorithms of many Enigma machine models, allowing to decode a message that has been encoded by a real Enigma machine and also the contrary.
 
+## Historical Accuracy & Verification
+
+**enigmapython** is rigorously tested against authentic historical data to ensure maximum accuracy.
+
+
+- [Authentic German Army Test Message from 1930](https://cryptocellar.org/enigma/e-message-1930.html): Documented by Frode Weierud's CryptoCellar, this test validates that the **Enigma I** implementation correctly handles the complex interaction of rotors, ring settings, and plugboard connections exactly as the original machines did. See the [corresponding unit test](https://github.com/denismaggior8/enigma-python/blob/master/tests/Enigma1930_tests.py) for details.
+
 ## Machines implementations
 
 The following Enigma machine models (along with their rotors, reflectors and plugboards) have been implemented:
@@ -148,7 +187,7 @@ The following Enigma machine models (along with their rotors, reflectors and plu
 
 ## Getting started
 
-Please have a look of the [examples](https://github.com/denismaggior8/enigma-python/blob/master/examples/enigma_machines_examples.py) folder
+Get started by installing the package from PyPI (`pip install enigmapython`) and exploring the examples in the [examples](https://github.com/denismaggior8/enigma-python/tree/master/examples) folder.
 
 ## Documentation
 
@@ -161,16 +200,28 @@ Here's a list containing all the known Enigma simulators that use the **enigmapy
 - [Enigma TUI](https://github.com/denismaggior8/enigma-tui). **Enigma TUI** is a **T**erminal **U**ser **I**nterface for Enigma machines, allowing you to simulate different Enigma machine models from the terminal. It employs  **enigmapython** as Enigma engine. 
 
 <div class="img-container" style="text-align: center;"> 
-    <img src="img/enigmatui.png" alt="drawing" width="400" align="center"/>
+    <img src="https://raw.githubusercontent.com/denismaggior8/enigma-python/master/img/enigmatui.png" alt="drawing" width="400" align="center"/>
 </div>
+<br>
+<br>
 
+- [MicroPython Enigma Python](https://github.com/denismaggior8/micropython-enigma-python). **MicroPython Enigma Python** is a side project to bring Enigma Python library also on ambedded devices which runs MicroPython. It has been referenced on https://awesome-micropython.com/#historical, a curated list of the best MicroPython libraries, in the Cryptography/Historical section.
 
-- [Retrocampus BBS Enigma simulator](https://retrocampus.com/bbs/). When connected to the BBS, type E to access an Enigma M3 cypher machine whose backend is based on **enigmapython**.
+<div class="img-container" style="text-align: center;"> 
+    <img src="https://raw.githubusercontent.com/denismaggior8/enigma-python/master/img/micropython-enigma-python.png" alt="drawing" width="400" align="center"/>
+</div>
 
+<br>
+<br>
+
+- [Retrocampus BBS Enigma simulator](https://retrocampus.com/bbs/). When connected to the BBS, type E to access an Enigma M3 cypher machine whose backend is based on **enigmapython**.
 <div class="img-container" style="text-align: center;">
-    <img src="img/retrocampus_enigma.png" alt="drawing" width="400" align="center"/>
+    <img src="https://raw.githubusercontent.com/denismaggior8/enigma-python/master/img/retrocampus_enigma.png" alt="drawing" width="400" align="center"/>
 </div>
 
+<br>
+<br>
+
 In the case you leveraged **enigmapython** API in a project, either public or not, drop me an email at __denis.maggiorotto[at]gmail.com__ and I'll be happy to list you here.
 
 

{enigmapython-1.3.0 → enigmapython-1.3.2}/setup.py

@@ -12,11 +12,17 @@ setup(
     long_description_content_type='text/markdown',
     url="https://github.com/denismaggior8/enigma-python",
     name="enigmapython",
-    version="1.3.0",
+    version="1.3.2",
     packages=find_packages(
         # All keyword arguments below are optional:
         where='.',  # '.' by default
         include=['enigmapython'],  # ['*'] by default
     ),
+    classifiers=[
+        "Programming Language :: Python :: 3",
+        "Operating System :: OS Independent",
+        "License :: OSI Approved :: MIT License",
+    ],
+    license="MIT",
     description="A simple yet faithful library to emulate different Enigma machines models using Python"
 )