diff options
| author | Alex Gaynor <alex.gaynor@gmail.com> | 2013-12-17 07:35:34 -0800 |
|---|---|---|
| committer | Alex Gaynor <alex.gaynor@gmail.com> | 2013-12-17 07:35:34 -0800 |
| commit | 875b36be29e6bcfd1cb2a9cb216aba49c1d9d2f0 (patch) | |
| tree | 71372f15c53afdd4bf2459e9a4774f3d526075a5 /docs/index.rst | |
| parent | 4eec0bb4e1d79f107f40b3856f2c9ec76c3eef88 (diff) | |
| parent | a4aa420cc6c0203d201a0f418af68d1f11abbcf5 (diff) | |
| download | cryptography-875b36be29e6bcfd1cb2a9cb216aba49c1d9d2f0.tar.gz cryptography-875b36be29e6bcfd1cb2a9cb216aba49c1d9d2f0.tar.bz2 cryptography-875b36be29e6bcfd1cb2a9cb216aba49c1d9d2f0.zip | |
Merge branch 'master' into no-more-generator
Conflicts:
tests/hazmat/primitives/utils.py
Diffstat (limited to 'docs/index.rst')
| -rw-r--r-- | docs/index.rst | 42 |
1 files changed, 30 insertions, 12 deletions
diff --git a/docs/index.rst b/docs/index.rst index a1a650a8..381063df 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -1,10 +1,6 @@ Welcome to ``cryptography`` =========================== -.. warning:: - - ``cryptography`` is very young, and very incomplete. - ``cryptography`` is a Python library which exposes cryptographic recipes and primitives. We hope it'll be your one-stop-shop for all your cryptographic needs in Python. @@ -36,9 +32,24 @@ existing libraries: * Poor introspectability, and thus poor testability. * Extremely error prone APIs, and bad defaults. +Layout +------ + +``cryptography`` is broadly divided into two levels. One with safe +cryptographic recipes, "cryptography for humans" if you will. These are safe +and easy to use and don't require developers to make many decisions. + +The other level is low-level cryptographic primitives. These are often +dangerous and can be used incorrectly. They require making decisions and having +an in-depth knowledge of the cryptographic concepts at work. Because of the +potential danger in working at this level, this is referred to as the +"hazardous materials" or "hazmat" layer. -Contents --------- +We recommend using the recipes layer whenever possible, and falling back to the +hazmat layer only when necessary. + +The recipes layer +~~~~~~~~~~~~~~~~~ .. toctree:: :maxdepth: 2 @@ -46,15 +57,22 @@ Contents architecture exceptions glossary - contributing - security - community -Hazardous Materials -------------------- +The hazardous materials layer +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ .. toctree:: :maxdepth: 2 hazmat/primitives/index - hazmat/bindings/index + hazmat/backends/index + +The ``cryptography`` open source project +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +.. toctree:: + :maxdepth: 2 + + contributing + security + community |