bgneal@51: .. m209 documentation master file, created by
bgneal@51:    sphinx-quickstart on Thu Jul  4 18:12:07 2013.
bgneal@51:    You can adapt this file completely to your liking, but it should at least
bgneal@51:    contain the root `toctree` directive.
bgneal@51: 
bgneal@51: Welcome to m209's documentation!
bgneal@51: ================================
bgneal@51: 
bgneal@52: :Author: Brian Neal <bgneal@gmail.com>
bgneal@52: :Version: |release|
bgneal@52: :Date: |today|
bgneal@52: :Home Page: https://bitbucket.org/bgneal/m209/
bgneal@52: :License: MIT License (see LICENSE.txt)
bgneal@52: :Documentation: http://m209.readthedocs.org/
bgneal@52: :Support: https://bitbucket.org/bgneal/m209/issues
bgneal@52: 
bgneal@52: Introduction
bgneal@52: ------------
bgneal@52: 
bgneal@52: ``m209`` is a complete `M-209`_ simulation library and command-line application
bgneal@52: written in Python 3. ``m209`` is historically accurate, meaning that it can
bgneal@52: exchange messages with an actual M-209 cipher machine.
bgneal@52: 
bgneal@52: It is hoped that this library will be useful to M-209 enthusiasts, historians,
bgneal@52: and students interested in cryptography.
bgneal@52: 
bgneal@52: ``m209`` strives to be Pythonic, easy to use, and comes with both unit tests
bgneal@52: and documentation. ``m209`` is a library for building applications for
bgneal@52: encrypting and decrypting M-209 messages. ``m209`` also ships with a simple
bgneal@52: command-line application that can encrypt & decrypt messages for scripting and
bgneal@52: experimentation.
bgneal@52: 
bgneal@52: Command-line Example
bgneal@52: --------------------
bgneal@52: 
bgneal@52: Library Example
bgneal@52: ---------------
bgneal@52: 
bgneal@52: Requirements
bgneal@52: ------------
bgneal@52: 
bgneal@52: ``m209`` is written in Python_, specifically Python 3.3. It has no other
bgneal@52: requirements or dependencies.
bgneal@52: 
bgneal@52: Installation
bgneal@52: ------------
bgneal@52: 
bgneal@52: ``m209`` is available on the `Python Package Index`_ (PyPI). You can install it
bgneal@52: using pip_::
bgneal@52: 
bgneal@52:    $ pip install m209                  # install
bgneal@52:    $ pip install --upgrade m209        # upgrade
bgneal@52: 
bgneal@52: You may also download a tarball or .zip file of the latest code using the "get
bgneal@52: source" link on the `m209 Bitbucket page`_. Alternatively if you use
bgneal@52: Mercurial_, you can clone the repository with the following command::
bgneal@52: 
bgneal@52:    $ hg clone https://bitbucket.org/bgneal/m209
bgneal@52: 
bgneal@52: If you did not use pip, you can install with this command::
bgneal@52: 
bgneal@52:    $ python setup.py install
bgneal@52: 
bgneal@52: 
bgneal@52: Support & Source
bgneal@52: ----------------
bgneal@52: 
bgneal@52: All support takes place at the `m209 Bitbucket page`_. Please enter any
bgneal@52: feature requests or bugs into the `issue tracker`_.
bgneal@52: 
bgneal@52: Next Steps
bgneal@52: ----------
bgneal@52: 
bgneal@51: Contents:
bgneal@51: 
bgneal@51: .. toctree::
bgneal@51:    :maxdepth: 2
bgneal@51: 
bgneal@51: 
bgneal@51: 
bgneal@51: Indices and tables
bgneal@51: ==================
bgneal@51: 
bgneal@51: * :ref:`genindex`
bgneal@51: * :ref:`modindex`
bgneal@51: * :ref:`search`
bgneal@51: 
bgneal@52: 
bgneal@52: .. _M-209: http://en.wikipedia.org/wiki/M-209
bgneal@52: .. _Python: http://www.python.org
bgneal@52: .. _Python Package Index: http://pypi.python.org/pypi/m209/
bgneal@52: .. _m209 Bitbucket page: https://bitbucket.org/bgneal/m209
bgneal@52: .. _pip: http://www.pip-installer.org
bgneal@52: .. _Mercurial: http://mercurial.selenic.com/
bgneal@52: .. _issue tracker: https://bitbucket.org/bgneal/m209/issues