enigma-cipher 1.1.0

Package providing encoder and decoder instances to use the enigma machine cipher

Enigma Cipher

The Enigma Cipher is a package that allows ciphering texts as an enigma machine would.

It is referred to 'cipher' the text instead of encoding/decoding, as any text can be encoded or decoded bz ciphering it with a machine with the same configuration. For example, if the text VLGBR OYWVV! is ciphered through a machine with the correct configuration, the outcome will be HELLO WORLD!

📖 Documentation

You can find the documentation:

• Within the /docs folder
• At the mkdocs generated page (official documentation)

🐍 Python Setup

Requirements

• Python 3.8 or higher

Installation

The package is installable via pip:

pip install enigma-cipher

The 'develop' branch can also be installed to work with unreleased features:

pip install git+https://github.com/Jtachan/enigma_cipher.git@develop