Py-Enigma
latest
  • Overview
  • User’s guide
  • Reference manual
  • pyenigma command-line application
  • Key file format
Py-Enigma
  • Docs »
  • Welcome to Py-Enigma’s documentation!
  • Edit on Bitbucket

Welcome to Py-Enigma’s documentation!¶

Author:Brian Neal <bgneal@gmail.com>
Version:0.1
Date:Sep 04, 2017
Home Page:https://bitbucket.org/bgneal/enigma/
License:MIT License (see LICENSE.txt)
Documentation:http://py-enigma.readthedocs.org/
Support:https://bitbucket.org/bgneal/enigma/issues

Py-Enigma is a historically accurate Enigma machine simulation library written in Python. Py-Enigma includes a simple command-line application to allow for quick experimenting and scripting.

Documentation contents:

  • Overview
    • Introduction
    • Scope
    • Quick Example
    • Requirements
    • Installation
    • Support & Source
    • Acknowledgements & References
  • User’s guide
    • If you are new to Enigma machines
    • Building your Enigma machine
      • Using key sheet shortcuts
      • Constructing by hand
    • Encrypting & Decrypting
    • Example communication procedure
  • Reference manual
    • EnigmaMachines
      • EnigmaMachine class reference
      • EnigmaMachine exceptions
    • Rotors & Reflectors
      • Rotor class reference
      • A note on the entry wheel and reflectors
      • Rotor & reflector factory functions
      • Rotor exceptions
    • Plugboards
      • Plugboard class reference
      • Plugboard exceptions
  • pyenigma command-line application
    • Getting help
    • Specifying all key settings
    • Using a key file for settings
    • Verbose output
  • Key file format

Indices and tables¶

  • Index
  • Search Page
Next

© Copyright 2012, Brian Neal. Revision f3af458a5d2d.

Built with Sphinx using a theme provided by Read the Docs.
Read the Docs v: latest
Versions
latest
stable
Downloads
pdf
htmlzip
epub
On Read the Docs
Project Home
Builds

Free document hosting provided by Read the Docs.