Skip to content

Commit aa910e7

Browse files
mattsb42-awsmattsb42-aws
authored
Merge pull request #53 from mattsb42-aws/revamp-docs
Revamp docs
2 parents dd3efe9 + 199742c commit aa910e7

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

51 files changed

+339
-74
lines changed

‎.gitignore

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,7 @@
88
/.coverage*
99
/build
1010
/doc/generated/*
11+
/doc/lib/generated/*
1112
/runpy
1213
__pycache__
1314
build

‎CHANGELOG.rst

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
*********
2+
Changelog
3+
*********
4+
5+
1.x.x -- 2018-xx-xx
6+
===================
7+
* Initial public release

‎README.rst

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
#####################################
2+
DynamoDB Encryption Client for Python
3+
#####################################

‎doc/conf.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -38,7 +38,7 @@ def get_version():
3838
extensions = ['sphinx.ext.autodoc', 'sphinx.ext.doctest',
3939
'sphinx.ext.intersphinx', 'sphinx.ext.todo',
4040
'sphinx.ext.coverage', 'sphinx.ext.autosummary',
41-
'sphinx.ext.napoleon']
41+
'sphinx.ext.napoleon', 'sphinx.ext.viewcode']
4242
napoleon_include_special_with_doc = False
4343

4444
# Add any paths that contain templates here, relative to this directory.

‎doc/index.rst

Lines changed: 37 additions & 49 deletions
Original file line numberDiff line numberDiff line change
@@ -1,53 +1,41 @@
11
.. include:: ../README.rst
22

3-
*******
4-
Modules
5-
*******
6-
7-
.. autosummary::
8-
:toctree: generated
9-
10-
.. Add/replace module names you want documented here
11-
dynamodb_encryption_sdk
12-
dynamodb_encryption_sdk.exceptions
13-
dynamodb_encryption_sdk.identifiers
14-
dynamodb_encryption_sdk.structures
15-
dynamodb_encryption_sdk.transform
16-
dynamodb_encryption_sdk.delegated_keys
17-
dynamodb_encryption_sdk.delegated_keys.jce
18-
dynamodb_encryption_sdk.encrypted
19-
dynamodb_encryption_sdk.encrypted.client
20-
dynamodb_encryption_sdk.encrypted.item
21-
dynamodb_encryption_sdk.encrypted.resource
22-
dynamodb_encryption_sdk.encrypted.table
23-
dynamodb_encryption_sdk.material_providers
24-
dynamodb_encryption_sdk.material_providers.aws_kms
25-
dynamodb_encryption_sdk.material_providers.most_recent
26-
dynamodb_encryption_sdk.material_providers.static
27-
dynamodb_encryption_sdk.material_providers.wrapped
28-
dynamodb_encryption_sdk.material_providers.store
29-
dynamodb_encryption_sdk.material_providers.store.meta
30-
dynamodb_encryption_sdk.materials
31-
dynamodb_encryption_sdk.materials.raw
32-
dynamodb_encryption_sdk.materials.wrapped
33-
dynamodb_encryption_sdk.internal
34-
dynamodb_encryption_sdk.internal.dynamodb_types
35-
dynamodb_encryption_sdk.internal.identifiers
36-
dynamodb_encryption_sdk.internal.str_ops
37-
dynamodb_encryption_sdk.internal.utils
38-
dynamodb_encryption_sdk.internal.validators
39-
dynamodb_encryption_sdk.internal.crypto
40-
dynamodb_encryption_sdk.internal.crypto.authentication
41-
dynamodb_encryption_sdk.internal.crypto.encryption
42-
dynamodb_encryption_sdk.internal.crypto.jce_bridge
43-
dynamodb_encryption_sdk.internal.crypto.jce_bridge.authentication
44-
dynamodb_encryption_sdk.internal.crypto.jce_bridge.encryption
45-
dynamodb_encryption_sdk.internal.crypto.jce_bridge.primitives
46-
dynamodb_encryption_sdk.internal.formatting
47-
dynamodb_encryption_sdk.internal.formatting.material_description
48-
dynamodb_encryption_sdk.internal.formatting.deserialize
49-
dynamodb_encryption_sdk.internal.formatting.deserialize.attribute
50-
dynamodb_encryption_sdk.internal.formatting.serialize
51-
dynamodb_encryption_sdk.internal.formatting.serialize.attribute
3+
API
4+
***
5+
6+
.. toctree::
7+
:maxdepth: 2
8+
:caption: Encryption Helpers
9+
10+
lib/encrypted/config.rst
11+
lib/encrypted/helpers
12+
lib/encrypted/item
13+
14+
.. toctree::
15+
:maxdepth: 2
16+
:caption: Key Management
17+
18+
lib/materials_providers/providers
19+
lib/materials_providers/provider_stores
20+
lib/materials/index
21+
22+
.. toctree::
23+
:maxdepth: 2
24+
:caption: Cryptographic Operators
25+
26+
lib/delegated_keys/index
27+
28+
.. toctree::
29+
:maxdepth: 2
30+
:caption: Additional Resources
31+
32+
lib/tools/index
33+
lib/tools/exceptions
34+
35+
.. toctree::
36+
:maxdepth: 1
37+
:caption: Informational Only
38+
39+
lib/internal
5240

5341
.. include:: ../CHANGELOG.rst

‎doc/lib/delegated_keys/index.rst

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
Delegated Keys
2+
==============
3+
4+
.. toctree::
5+
6+
jce
7+
8+
.. autosummary::
9+
10+
dynamodb_encryption_sdk.delegated_keys
11+
dynamodb_encryption_sdk.delegated_keys.jce

‎doc/lib/delegated_keys/jce.rst

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
JCE Standard Name Delegated Key
2+
-------------------------------
3+
4+
.. automodule:: dynamodb_encryption_sdk.delegated_keys.jce

‎doc/lib/encrypted/client.rst

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
Encrypted Client
2+
----------------
3+
4+
.. automodule:: dynamodb_encryption_sdk.encrypted.client

‎doc/lib/encrypted/config.rst

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
Cryptographic Configuration
2+
---------------------------
3+
4+
.. automodule:: dynamodb_encryption_sdk.encrypted

‎doc/lib/encrypted/helpers.rst

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
Helper Clients
2+
==============
3+
4+
.. toctree::
5+
6+
table
7+
resource
8+
client
9+
10+
.. autosummary::
11+
12+
dynamodb_encryption_sdk.encrypted.table
13+
dynamodb_encryption_sdk.encrypted.resource
14+
dynamodb_encryption_sdk.encrypted.client

‎doc/lib/encrypted/item.rst

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
Item Encryptor
2+
--------------
3+
4+
.. automodule:: dynamodb_encryption_sdk.encrypted.item

‎doc/lib/encrypted/resource.rst

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
Encrypted Service Resource
2+
--------------------------
3+
4+
.. automodule:: dynamodb_encryption_sdk.encrypted.resource

‎doc/lib/encrypted/table.rst

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
Encrypted Table Resource
2+
------------------------
3+
4+
.. automodule:: dynamodb_encryption_sdk.encrypted.table

‎doc/lib/internal.rst

Lines changed: 28 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,28 @@
1+
Internal Resources
2+
==================
3+
4+
.. warning::
5+
6+
These are provided for informational purposes only. No guarantee is provided on the modules
7+
and APIs described here remaining consistent. Directly reference at your own risk.
8+
9+
.. autosummary::
10+
:toctree: generated
11+
12+
dynamodb_encryption_sdk.internal.identifiers
13+
dynamodb_encryption_sdk.internal.str_ops
14+
dynamodb_encryption_sdk.internal.utils
15+
dynamodb_encryption_sdk.internal.validators
16+
dynamodb_encryption_sdk.internal.crypto
17+
dynamodb_encryption_sdk.internal.crypto.authentication
18+
dynamodb_encryption_sdk.internal.crypto.encryption
19+
dynamodb_encryption_sdk.internal.crypto.jce_bridge
20+
dynamodb_encryption_sdk.internal.crypto.jce_bridge.authentication
21+
dynamodb_encryption_sdk.internal.crypto.jce_bridge.encryption
22+
dynamodb_encryption_sdk.internal.crypto.jce_bridge.primitives
23+
dynamodb_encryption_sdk.internal.formatting
24+
dynamodb_encryption_sdk.internal.formatting.material_description
25+
dynamodb_encryption_sdk.internal.formatting.deserialize
26+
dynamodb_encryption_sdk.internal.formatting.deserialize.attribute
27+
dynamodb_encryption_sdk.internal.formatting.serialize
28+
dynamodb_encryption_sdk.internal.formatting.serialize.attribute

‎doc/lib/materials/index.rst

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
Cryptographic Materials
2+
-----------------------
3+
4+
.. toctree::
5+
6+
wrapped
7+
raw
8+
9+
.. autosummary::
10+
11+
dynamodb_encryption_sdk.materials
12+
dynamodb_encryption_sdk.materials.raw
13+
dynamodb_encryption_sdk.materials.wrapped

‎doc/lib/materials/raw.rst

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
Raw Cryptographic Materials
2+
---------------------------
3+
4+
.. automodule:: dynamodb_encryption_sdk.materials.raw

‎doc/lib/materials/wrapped.rst

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
Wrapped Cryptographic Materials
2+
-------------------------------
3+
4+
.. automodule:: dynamodb_encryption_sdk.materials.wrapped

‎doc/lib/materials_providers/aws_kms.rst

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
AWS KMS Provider
2+
----------------
3+
4+
.. automodule:: dynamodb_encryption_sdk.material_providers.aws_kms

‎doc/lib/materials_providers/metastore.rst

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
MetaStore
2+
---------
3+
4+
.. automodule:: dynamodb_encryption_sdk.material_providers.store.meta

‎doc/lib/materials_providers/most_recent.rst

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
Most Recent Provider
2+
--------------------
3+
4+
.. automodule:: dynamodb_encryption_sdk.material_providers.most_recent

‎doc/lib/materials_providers/provider_stores.rst

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
Provider Stores
2+
===============
3+
4+
.. toctree::
5+
6+
metastore
7+
8+
.. autosummary::
9+
10+
dynamodb_encryption_sdk.material_providers.store
11+
dynamodb_encryption_sdk.material_providers.store.meta

‎doc/lib/materials_providers/providers.rst

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
Cryptographic Materials Providers
2+
=================================
3+
4+
.. toctree::
5+
6+
aws_kms
7+
wrapped
8+
most_recent
9+
static
10+
11+
.. autosummary::
12+
13+
dynamodb_encryption_sdk.material_providers
14+
dynamodb_encryption_sdk.material_providers.wrapped
15+
dynamodb_encryption_sdk.material_providers.most_recent
16+
dynamodb_encryption_sdk.material_providers.static

‎doc/lib/materials_providers/static.rst

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
Static Provider
2+
---------------
3+
4+
.. automodule:: dynamodb_encryption_sdk.material_providers.static

‎doc/lib/materials_providers/wrapped.rst

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
Wrapped Provider
2+
----------------
3+
4+
.. automodule:: dynamodb_encryption_sdk.material_providers.wrapped

‎doc/lib/tools/exceptions.rst

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
Exceptions
2+
----------
3+
4+
.. automodule:: dynamodb_encryption_sdk.exceptions

‎doc/lib/tools/identifiers.rst

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
Identifiers
2+
-----------
3+
4+
.. automodule:: dynamodb_encryption_sdk.identifiers

‎doc/lib/tools/index.rst

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
Tools
2+
=====
3+
4+
.. toctree::
5+
6+
identifiers
7+
structures
8+
transform
9+
10+
.. autosummary::
11+
12+
dynamodb_encryption_sdk.identifiers
13+
dynamodb_encryption_sdk.structures
14+
dynamodb_encryption_sdk.transform

‎doc/lib/tools/structures.rst

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
Structures
2+
----------
3+
4+
.. automodule:: dynamodb_encryption_sdk.structures

‎doc/lib/tools/transform.rst

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
Transformers
2+
------------
3+
4+
.. automodule:: dynamodb_encryption_sdk.transform

‎setup.py

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
"""DynamoDB Encryption SDK."""
1+
"""DynamoDB Encryption Client for Python."""
22
import io
33
import os
44
import re
@@ -31,12 +31,13 @@ def get_requirements():
3131
version=get_version(),
3232
packages=find_packages('src'),
3333
package_dir={'': 'src'},
34-
url='http://dynamodb-encryption-sdk.readthedocs.io/en/latest/',
34+
url='https://github.com/awslabs/aws-dynamodb-encryption-python',
3535
author='Amazon Web Services',
3636
author_email='[email protected]',
3737
maintainer='Amazon Web Services',
38+
description='DynamoDB Encryption Client for Python',
3839
long_description=read('README.rst'),
39-
keywords='aws-encryption-sdk aws kms encryption dynamodb',
40+
keywords='dynamodb-encryption-sdk aws kms encryption dynamodb',
4041
data_files=[
4142
'README.rst',
4243
'CHANGELOG.rst',

‎src/dynamodb_encryption_sdk/delegated_keys/jce.py

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@
1010
# distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF
1111
# ANY KIND, either express or implied. See the License for the specific
1212
# language governing permissions and limitations under the License.
13-
"""Delegated key that JCE StandardName algorithm values to determine behavior."""
13+
"""Delegated key that uses JCE StandardName values to determine behavior."""
1414
from __future__ import division
1515

1616
import logging
@@ -76,7 +76,7 @@ def _generate_rsa_key(key_length):
7676
@attr.s(init=False)
7777
class JceNameLocalDelegatedKey(DelegatedKey):
7878
# pylint: disable=too-many-instance-attributes
79-
"""Delegated key that uses JCE StandardName algorithm values to determine behavior.
79+
"""Delegated key that uses JCE StandardName values to determine behavior.
8080
8181
Accepted algorithm names for this include:
8282

‎src/dynamodb_encryption_sdk/encrypted/__init__.py

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -32,7 +32,8 @@
3232

3333
@attr.s(init=False)
3434
class CryptoConfig(object):
35-
"""Container for all configuration needed to encrypt or decrypt an item.
35+
"""Container for all configuration needed to encrypt or decrypt an item using the item
36+
encryptor functions in :py:mod:`dynamodb_encryption_sdk.encrypted.item`.
3637
3738
:param CryptographicMaterialsProvider materials_provider: Cryptographic materials provider
3839
to use

‎src/dynamodb_encryption_sdk/internal/crypto/__init__.py

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,4 +10,9 @@
1010
# distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF
1111
# ANY KIND, either express or implied. See the License for the specific
1212
# language governing permissions and limitations under the License.
13-
"""Inner cryptographic components."""
13+
"""Inner cryptographic components.
14+
15+
.. warning::
16+
No guarantee is provided on the modules and APIs within this
17+
namespace staying consistent. Directly reference at your own risk.
18+
"""

‎src/dynamodb_encryption_sdk/internal/crypto/authentication.py

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,12 @@
1010
# distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF
1111
# ANY KIND, either express or implied. See the License for the specific
1212
# language governing permissions and limitations under the License.
13-
"""Functions to handle calculating and verifying signatures of encrypted items."""
13+
"""Functions to handle calculating and verifying signatures of encrypted items.
14+
15+
.. warning::
16+
No guarantee is provided on the modules and APIs within this
17+
namespace staying consistent. Directly reference at your own risk.
18+
"""
1419
from cryptography.hazmat.backends import default_backend
1520
from cryptography.hazmat.primitives import hashes
1621

0 commit comments

Comments
 (0)