termigma 1.0.0__tar.gz

termigma-1.0.0/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Rex Ackermann
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

termigma-1.0.0/PKG-INFO

@@ -0,0 +1,130 @@
+Metadata-Version: 2.4
+Name: termigma
+Version: 1.0.0
+Summary: An interactive terminal (TUI) Enigma machine simulator
+Author: Rex Ackermann
+License-Expression: MIT
+Project-URL: Homepage, https://github.com/rexackermann/termigma
+Project-URL: Repository, https://github.com/rexackermann/termigma
+Project-URL: Issues, https://github.com/rexackermann/termigma/issues
+Project-URL: Changelog, https://github.com/rexackermann/termigma/blob/main/CHANGELOG.md
+Project-URL: Reference simulator, https://people.physik.hu-berlin.de/~palloks/js/enigma/enigma-u_v262_en.html
+Keywords: enigma,cipher,cryptography,tui,curses,terminal,wwii,history
+Classifier: Development Status :: 5 - Production/Stable
+Classifier: Environment :: Console :: Curses
+Classifier: Intended Audience :: Education
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3 :: Only
+Classifier: Topic :: Security :: Cryptography
+Classifier: Topic :: Games/Entertainment :: Simulation
+Classifier: Topic :: Education
+Requires-Python: >=3.8
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: windows-curses; platform_system == "Windows"
+Provides-Extra: dev
+Requires-Dist: pytest>=7; extra == "dev"
+Dynamic: license-file
+
+# termigma
+
+A terminal simulator of the Wehrmacht/Kriegsmarine Enigma machine — rotors,
+plugboard, lampboard, and a live signal-path monitor, all in your terminal.
+
+```
+pip install termigma
+termigma
+```
+
+No dependencies on Linux/macOS (just the standard library's `curses`). On
+Windows, `pip install termigma` pulls in `windows-curses` automatically.
+
+## What it does
+
+You type a letter, it lights up on the lampboard, and the **signal path**
+panel shows exactly how it got there: plugboard → entry wheel → through each
+rotor → reflector → back through the rotors → entry wheel → plugboard → lamp.
+The rotors step on every keypress, including the historically correct
+middle-rotor "double step," and there's no undo — same as the real machine.
+
+It covers three points in the machine's history:
+
+- **Enigma I** (Army/Air Force) — 3 rotors chosen from I–V
+- **M3** (Army/Navy) — 3 rotors chosen from I–VIII
+- **M4 "Shark"** (U-boats) — adds a fourth, non-stepping Beta/Gamma wheel and
+  a thin reflector
+
+Plus a **commercial-style** mode that demonstrates the real quirk of
+commercial Enigmas: no plugboard, and an entry wheel wired in keyboard
+(QWERTZU) order instead of straight A–Z.
+
+## Controls
+
+| Key | Does |
+|---|---|
+| `A`–`Z` | Encipher a letter |
+| `Space` | Visual separator (doesn't step the rotors) |
+| `F1` | Help |
+| `F2` | Settings — model preset, ETW mode, plugboard on/off, reflector, movable notches, 4th wheel, all three rotors |
+| `F3` | Plugboard editor |
+| `F5` | Custom rewirable reflector editor (needs Reflector = Custom) |
+| `F4` | Reset to defaults |
+| `Esc` / `Q` | Quit |
+
+Terminal needs to be at least 108×34 or it'll ask you to resize.
+
+## Why it looks the way it does
+
+Real Enigmas didn't have an undo button, a Ctrl-Z, or a way to peek inside
+while it ran. This tries to keep that feel — the rotors always turn, the
+plugboard is genuinely optional depending on which model you pick — while
+also showing you the one thing the real machine couldn't: what's happening
+electrically at every stage, for every keystroke.
+
+## Project layout
+
+```
+src/termigma/engine.py   the machine itself — no curses, fully unit-testable
+src/termigma/tui.py      curses rendering and the input loop
+tests/test_engine.py     pytest suite (reciprocity checks, stepping, etc.)
+data/wiring_tables.json  the historical wiring data, with sourcing notes
+```
+
+## Running from source
+
+```
+git clone https://github.com/rexackermann/termigma
+cd termigma
+pip install -e ".[dev]"
+pytest
+termigma
+```
+
+## Accuracy
+
+The rotor and reflector wiring (rotors I–VIII, the M4 Beta/Gamma wheels, and
+reflectors B/C plus their thin M4 counterparts) is the widely published
+historical data, checked here against a known reference test vector and a
+set of round-trip (reciprocity) tests — see `tests/test_engine.py`.
+
+What's **not** included: exact wiring for the more exotic commercial and
+national variants (Enigma K, Enigma D, Swiss-K, Railway, Tirpitz, Norenigma,
+Sonder-Enigma, the Abwehr G-machines). This project doesn't have confidently
+sourced wiring for those, and a guess dressed up as fact is worse than an
+honest gap. The "commercial-style" preset demonstrates the real no-plugboard
+/ QWERTZU-entry-wheel behavior of commercial machines but reuses the Enigma I
+rotor set rather than true K/D rotors. See `data/wiring_tables.json` for the
+full sourcing note, and cross-check the Crypto Museum's Enigma pages if you
+need one of those specific machines to be byte-exact.
+
+## Credits
+
+- Inspired by Daniel Palloks' [Universal Enigma](https://people.physik.hu-berlin.de/~palloks/js/enigma/enigma-u_v262_en.html),
+  a browser-based simulator covering a much wider range of historical
+  Enigma variants than this project attempts.
+- Enigma explainer video: https://www.youtube.com/watch?v=JsBZOcqZerk — for inspiration.
+- Built with help from [Claude](https://claude.ai) (Anthropic).
+
+## License
+
+MIT — see [LICENSE](LICENSE).

termigma-1.0.0/README.md

@@ -0,0 +1,102 @@
+# termigma
+
+A terminal simulator of the Wehrmacht/Kriegsmarine Enigma machine — rotors,
+plugboard, lampboard, and a live signal-path monitor, all in your terminal.
+
+```
+pip install termigma
+termigma
+```
+
+No dependencies on Linux/macOS (just the standard library's `curses`). On
+Windows, `pip install termigma` pulls in `windows-curses` automatically.
+
+## What it does
+
+You type a letter, it lights up on the lampboard, and the **signal path**
+panel shows exactly how it got there: plugboard → entry wheel → through each
+rotor → reflector → back through the rotors → entry wheel → plugboard → lamp.
+The rotors step on every keypress, including the historically correct
+middle-rotor "double step," and there's no undo — same as the real machine.
+
+It covers three points in the machine's history:
+
+- **Enigma I** (Army/Air Force) — 3 rotors chosen from I–V
+- **M3** (Army/Navy) — 3 rotors chosen from I–VIII
+- **M4 "Shark"** (U-boats) — adds a fourth, non-stepping Beta/Gamma wheel and
+  a thin reflector
+
+Plus a **commercial-style** mode that demonstrates the real quirk of
+commercial Enigmas: no plugboard, and an entry wheel wired in keyboard
+(QWERTZU) order instead of straight A–Z.
+
+## Controls
+
+| Key | Does |
+|---|---|
+| `A`–`Z` | Encipher a letter |
+| `Space` | Visual separator (doesn't step the rotors) |
+| `F1` | Help |
+| `F2` | Settings — model preset, ETW mode, plugboard on/off, reflector, movable notches, 4th wheel, all three rotors |
+| `F3` | Plugboard editor |
+| `F5` | Custom rewirable reflector editor (needs Reflector = Custom) |
+| `F4` | Reset to defaults |
+| `Esc` / `Q` | Quit |
+
+Terminal needs to be at least 108×34 or it'll ask you to resize.
+
+## Why it looks the way it does
+
+Real Enigmas didn't have an undo button, a Ctrl-Z, or a way to peek inside
+while it ran. This tries to keep that feel — the rotors always turn, the
+plugboard is genuinely optional depending on which model you pick — while
+also showing you the one thing the real machine couldn't: what's happening
+electrically at every stage, for every keystroke.
+
+## Project layout
+
+```
+src/termigma/engine.py   the machine itself — no curses, fully unit-testable
+src/termigma/tui.py      curses rendering and the input loop
+tests/test_engine.py     pytest suite (reciprocity checks, stepping, etc.)
+data/wiring_tables.json  the historical wiring data, with sourcing notes
+```
+
+## Running from source
+
+```
+git clone https://github.com/rexackermann/termigma
+cd termigma
+pip install -e ".[dev]"
+pytest
+termigma
+```
+
+## Accuracy
+
+The rotor and reflector wiring (rotors I–VIII, the M4 Beta/Gamma wheels, and
+reflectors B/C plus their thin M4 counterparts) is the widely published
+historical data, checked here against a known reference test vector and a
+set of round-trip (reciprocity) tests — see `tests/test_engine.py`.
+
+What's **not** included: exact wiring for the more exotic commercial and
+national variants (Enigma K, Enigma D, Swiss-K, Railway, Tirpitz, Norenigma,
+Sonder-Enigma, the Abwehr G-machines). This project doesn't have confidently
+sourced wiring for those, and a guess dressed up as fact is worse than an
+honest gap. The "commercial-style" preset demonstrates the real no-plugboard
+/ QWERTZU-entry-wheel behavior of commercial machines but reuses the Enigma I
+rotor set rather than true K/D rotors. See `data/wiring_tables.json` for the
+full sourcing note, and cross-check the Crypto Museum's Enigma pages if you
+need one of those specific machines to be byte-exact.
+
+## Credits
+
+- Inspired by Daniel Palloks' [Universal Enigma](https://people.physik.hu-berlin.de/~palloks/js/enigma/enigma-u_v262_en.html),
+  a browser-based simulator covering a much wider range of historical
+  Enigma variants than this project attempts.
+- Enigma explainer video: https://www.youtube.com/watch?v=JsBZOcqZerk — for inspiration.
+- Built with help from [Claude](https://claude.ai) (Anthropic).
+
+## License
+
+MIT — see [LICENSE](LICENSE).

termigma-1.0.0/pyproject.toml

@@ -0,0 +1,44 @@
+[build-system]
+requires = ["setuptools>=68", "wheel"]
+build-backend = "setuptools.build_meta"
+
+[project]
+name = "termigma"
+version = "1.0.0"
+description = "An interactive terminal (TUI) Enigma machine simulator"
+readme = "README.md"
+license = "MIT"
+license-files = ["LICENSE"]
+authors = [{ name = "Rex Ackermann" }]
+requires-python = ">=3.8"
+keywords = ["enigma", "cipher", "cryptography", "tui", "curses", "terminal", "wwii", "history"]
+classifiers = [
+    "Development Status :: 5 - Production/Stable",
+    "Environment :: Console :: Curses",
+    "Intended Audience :: Education",
+    "Programming Language :: Python :: 3",
+    "Programming Language :: Python :: 3 :: Only",
+    "Topic :: Security :: Cryptography",
+    "Topic :: Games/Entertainment :: Simulation",
+    "Topic :: Education",
+]
+dependencies = ["windows-curses; platform_system == 'Windows'"]
+
+[project.optional-dependencies]
+dev = ["pytest>=7"]
+
+[project.scripts]
+termigma = "termigma.tui:main"
+
+[project.urls]
+Homepage = "https://github.com/rexackermann/termigma"
+Repository = "https://github.com/rexackermann/termigma"
+Issues = "https://github.com/rexackermann/termigma/issues"
+Changelog = "https://github.com/rexackermann/termigma/blob/main/CHANGELOG.md"
+"Reference simulator" = "https://people.physik.hu-berlin.de/~palloks/js/enigma/enigma-u_v262_en.html"
+
+[tool.setuptools.packages.find]
+where = ["src"]
+
+[tool.pytest.ini_options]
+testpaths = ["tests"]

termigma-1.0.0/setup.cfg

@@ -0,0 +1,4 @@
+[egg_info]
+tag_build = 
+tag_date = 0
+

termigma-1.0.0/src/termigma/__init__.py

@@ -0,0 +1,6 @@
+"""termigma - an interactive terminal Enigma machine simulator."""
+
+from .engine import Enigma
+
+__version__ = "1.0.0"
+__all__ = ["Enigma", "__version__"]

termigma-1.0.0/src/termigma/__main__.py

@@ -0,0 +1,4 @@
+from .tui import main
+
+if __name__ == "__main__":
+    main()