Mercurial > public > enigma

view enigma/__init__.py @ 47:38da44b09e43 0.1

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Add the docs to the setup.py package_data.
author Brian Neal <bgneal@gmail.com>
date Tue, 05 Jun 2012 19:22:14 -0500
parents 62e0d0e2628b
children
line wrap: on
line source
# Copyright (C) 2012 by Brian Neal.
# This file is part of Py-Enigma, the Enigma Machine simulation.
# Py-Enigma is released under the MIT License (see License.txt).

"""This package is a simulation of the Enigma Machines used by the German armed
forces (Wehrmacht) during World War II. These include the army (Heer), air force
(Luftwaffe), and navy (Kriegsmarine). For our purposes, the Heer and Luftwaffe
versions are identical. The Kriegsmarine models M3 and M4 can be simulated by
configuring an EnigmaMachine object with the suitable rotors and reflectors.

For a list of the rotors and reflectors we simulate, see the module rotors.data.

"""
__version__ = '0.1'