|
bgneal@51
|
1 .. m209 documentation master file, created by
|
|
bgneal@51
|
2 sphinx-quickstart on Thu Jul 4 18:12:07 2013.
|
|
bgneal@51
|
3 You can adapt this file completely to your liking, but it should at least
|
|
bgneal@51
|
4 contain the root `toctree` directive.
|
|
bgneal@51
|
5
|
|
bgneal@51
|
6 Welcome to m209's documentation!
|
|
bgneal@51
|
7 ================================
|
|
bgneal@51
|
8
|
|
bgneal@52
|
9 :Author: Brian Neal <bgneal@gmail.com>
|
|
bgneal@52
|
10 :Version: |release|
|
|
bgneal@52
|
11 :Date: |today|
|
|
bgneal@52
|
12 :Home Page: https://bitbucket.org/bgneal/m209/
|
|
bgneal@52
|
13 :License: MIT License (see LICENSE.txt)
|
|
bgneal@52
|
14 :Documentation: http://m209.readthedocs.org/
|
|
bgneal@52
|
15 :Support: https://bitbucket.org/bgneal/m209/issues
|
|
bgneal@52
|
16
|
|
bgneal@52
|
17 Introduction
|
|
bgneal@52
|
18 ------------
|
|
bgneal@52
|
19
|
|
bgneal@52
|
20 ``m209`` is a complete `M-209`_ simulation library and command-line application
|
|
bgneal@52
|
21 written in Python 3. ``m209`` is historically accurate, meaning that it can
|
|
bgneal@52
|
22 exchange messages with an actual M-209 cipher machine.
|
|
bgneal@52
|
23
|
|
bgneal@52
|
24 It is hoped that this library will be useful to M-209 enthusiasts, historians,
|
|
bgneal@52
|
25 and students interested in cryptography.
|
|
bgneal@52
|
26
|
|
bgneal@52
|
27 ``m209`` strives to be Pythonic, easy to use, and comes with both unit tests
|
|
bgneal@52
|
28 and documentation. ``m209`` is a library for building applications for
|
|
bgneal@52
|
29 encrypting and decrypting M-209 messages. ``m209`` also ships with a simple
|
|
bgneal@52
|
30 command-line application that can encrypt & decrypt messages for scripting and
|
|
bgneal@52
|
31 experimentation.
|
|
bgneal@52
|
32
|
|
bgneal@52
|
33 Command-line Example
|
|
bgneal@52
|
34 --------------------
|
|
bgneal@52
|
35
|
|
bgneal@52
|
36 Library Example
|
|
bgneal@52
|
37 ---------------
|
|
bgneal@52
|
38
|
|
bgneal@52
|
39 Requirements
|
|
bgneal@52
|
40 ------------
|
|
bgneal@52
|
41
|
|
bgneal@52
|
42 ``m209`` is written in Python_, specifically Python 3.3. It has no other
|
|
bgneal@52
|
43 requirements or dependencies.
|
|
bgneal@52
|
44
|
|
bgneal@52
|
45 Installation
|
|
bgneal@52
|
46 ------------
|
|
bgneal@52
|
47
|
|
bgneal@52
|
48 ``m209`` is available on the `Python Package Index`_ (PyPI). You can install it
|
|
bgneal@52
|
49 using pip_::
|
|
bgneal@52
|
50
|
|
bgneal@52
|
51 $ pip install m209 # install
|
|
bgneal@52
|
52 $ pip install --upgrade m209 # upgrade
|
|
bgneal@52
|
53
|
|
bgneal@52
|
54 You may also download a tarball or .zip file of the latest code using the "get
|
|
bgneal@52
|
55 source" link on the `m209 Bitbucket page`_. Alternatively if you use
|
|
bgneal@52
|
56 Mercurial_, you can clone the repository with the following command::
|
|
bgneal@52
|
57
|
|
bgneal@52
|
58 $ hg clone https://bitbucket.org/bgneal/m209
|
|
bgneal@52
|
59
|
|
bgneal@52
|
60 If you did not use pip, you can install with this command::
|
|
bgneal@52
|
61
|
|
bgneal@52
|
62 $ python setup.py install
|
|
bgneal@52
|
63
|
|
bgneal@52
|
64
|
|
bgneal@52
|
65 Support & Source
|
|
bgneal@52
|
66 ----------------
|
|
bgneal@52
|
67
|
|
bgneal@52
|
68 All support takes place at the `m209 Bitbucket page`_. Please enter any
|
|
bgneal@52
|
69 feature requests or bugs into the `issue tracker`_.
|
|
bgneal@52
|
70
|
|
bgneal@52
|
71 Next Steps
|
|
bgneal@52
|
72 ----------
|
|
bgneal@52
|
73
|
|
bgneal@51
|
74 Contents:
|
|
bgneal@51
|
75
|
|
bgneal@51
|
76 .. toctree::
|
|
bgneal@51
|
77 :maxdepth: 2
|
|
bgneal@51
|
78
|
|
bgneal@51
|
79
|
|
bgneal@51
|
80
|
|
bgneal@51
|
81 Indices and tables
|
|
bgneal@51
|
82 ==================
|
|
bgneal@51
|
83
|
|
bgneal@51
|
84 * :ref:`genindex`
|
|
bgneal@51
|
85 * :ref:`modindex`
|
|
bgneal@51
|
86 * :ref:`search`
|
|
bgneal@51
|
87
|
|
bgneal@52
|
88
|
|
bgneal@52
|
89 .. _M-209: http://en.wikipedia.org/wiki/M-209
|
|
bgneal@52
|
90 .. _Python: http://www.python.org
|
|
bgneal@52
|
91 .. _Python Package Index: http://pypi.python.org/pypi/m209/
|
|
bgneal@52
|
92 .. _m209 Bitbucket page: https://bitbucket.org/bgneal/m209
|
|
bgneal@52
|
93 .. _pip: http://www.pip-installer.org
|
|
bgneal@52
|
94 .. _Mercurial: http://mercurial.selenic.com/
|
|
bgneal@52
|
95 .. _issue tracker: https://bitbucket.org/bgneal/m209/issues
|
