Start to document the architecture.

This commit is contained in:
Alex Gaynor 2013-08-07 12:59:04 -07:00
parent 39ffd9095a
commit 1abfac7909
2 changed files with 28 additions and 3 deletions

16
docs/architecture.rst Normal file
View file

@ -0,0 +1,16 @@
Architecture
============
.. warning::
Because ``cryptography`` is so young, much of this document is
aspirational, rather than documentation.
``cryptography`` has three different layers:
* ``cryptography.c``: This package contains bindings to low level cryptographic
libraries. Our initial target will be OpenSSL.
* ``cryptography.primitives``: This packages contains low level algorithms,
things like ``AES`` or ``SHA1``.
* ``cryptography``: This package contains higher level recipes, for example
"encrypt and then MAC".

View file

@ -1,7 +1,16 @@
Welcome to ``cryptography``'s documentation!
============================================
Welcome to ``cryptography``
===========================
.. warning::
``cryptography`` is very young, and very incomplete.
``cryptography`` is a Python library which exposes cryptographic primitives and
recipes.
Contents:
.. toctree::
:maxdepth: 2
:maxdepth: 2
architecture