enigmatui 1.0.0

Enigma TUI is a Terminal User Interface for Enigma machines, allowing you to simulate different Enigma machine models from the terminal

Enigma TUI (Terminal User Interface)

Enigma TUI is a Terminal User Interface for Enigma machines, allowing you to simulate different Enigma machine models from the terminal.

Built with Python, it employs enigmapython as Enigma engine and textual to render the interface.

Prerequisites

• Python 3.11
• Clone this repo, checkout the desired branch/tag and install requirements (pip install -r requirements.txt) or directly from PyPI using pip install enigmatui

How to run Enigma TUI

Use Python to run Enigma TUI's package

$ python enigmatui

How it works

Reading the usage instructions is more difficult than using the application itself.

Enigma TUI has a fairy simple user interface with a couple of screens to let you configure an Enigma machine (among the supported models) and encrypt/decrypt messages, plus seeing in realtime the machine internals (rotors positions, wirings) and how a single letter is scrambled from the keyboard to rotors, through reflector and back up to lamp.

Please refer to the following flowchart to navigate the app.

flowchart TD
%% Nodes
    A("Splash screen")
    B("Main screen")
    C("Configure screen")
    D("De/Encrypt screen")


%% Edge connections between nodes
    Start([Start]) --> A
    A -- Go to app --> B 
    C -- Save and exit --> B
    B -- Configure --> C
    B -- De/Encrypt --> D
    D -- Back --> B
    A -- Quit --> End([Stop])
    B -- Quit --> End([Stop])
    C -- Quit --> End([Stop])
    D -- Quit --> End([Stop])

Run Enigma TUI in development mode

By following this procedure, you leverage pytest-watch to live reloading the application upon Python code change. In addition, thanks to the textual run command with its --dev flag, changing the stylesheets reflects to the interface instantly.

$ pip install -r requirements-dev.txt
$ cd src/tui
$ ptw --runner "textual run --dev  enigmatui/__main__.py"      

The above commands are valid provided that you cloned the enigma-tui repository from GitHub and your terminal is in the repository's root directory.