initial package setup

Author: mattsb42-aws

.gitignore

@@ -0,0 +1,19 @@
+*.egg-info
+*.pyc
+*.pyo
+*~
+.DS_Store
+.tox
+/.cache*
+/.coverage*
+/build
+/doc/generated/*
+/runpy
+__pycache__
+build
+dist
+docs/build
+.python-version
+.mypy_cache
+.hypothesis
+.pytest_cache

CHANGELOG.rst

@@ -0,0 +1,70 @@
+# pylint: disable=invalid-name
+"""Sphinx configuration."""
+from datetime import datetime
+import io
+import os
+import re
+
+VERSION_RE = re.compile(r'''__version__ = ['"]([0-9.]+)['"]''')
+HERE = os.path.abspath(os.path.dirname(__file__))
+
+
+def read(*args):
+    """Reads complete file contents."""
+    return io.open(os.path.join(HERE, *args), encoding='utf-8').read()
+
+
+def get_release():
+    """Reads the release (full three-part version number) from this module."""
+    init = read('..', 'src', 'dynamodb_encryption_sdk', 'identifiers.py')
+    return VERSION_RE.search(init).group(1)
+
+
+def get_version():
+    """Reads the version (MAJOR.MINOR) from this module."""
+    _release = get_release()
+    split_version = _release.split('.')
+    if len(split_version) == 3:
+        return '.'.join(split_version[:2])
+    return _release
+
+
+project = u'dynamodb-encryption-sdk-python'
+version = get_version()
+release = get_release()
+
+# Add any Sphinx extension module names here, as strings. They can be extensions
+# coming with Sphinx (named 'sphinx.ext.*') or your custom ones.
+extensions = ['sphinx.ext.autodoc', 'sphinx.ext.doctest',
+              'sphinx.ext.intersphinx', 'sphinx.ext.todo',
+              'sphinx.ext.coverage', 'sphinx.ext.autosummary',
+              'sphinx.ext.napoleon']
+napoleon_include_special_with_doc = False
+
+# Add any paths that contain templates here, relative to this directory.
+templates_path = ['_templates']
+
+source_suffix = '.rst'  # The suffix of source filenames.
+master_doc = 'index'  # The master toctree document.
+
+copyright = u'%s, Amazon' % datetime.now().year  # pylint: disable=redefined-builtin
+
+# List of directories, relative to source directory, that shouldn't be searched
+# for source files.
+exclude_trees = ['_build']
+
+pygments_style = 'sphinx'
+
+autoclass_content = "both"
+autodoc_default_flags = ['show-inheritance', 'members']
+autodoc_member_order = 'bysource'
+
+html_theme = 'sphinx_rtd_theme'
+html_static_path = ['_static']
+htmlhelp_basename = '%sdoc' % project
+
+# Example configuration for intersphinx: refer to the Python standard library.
+intersphinx_mapping = {'http://docs.python.org/': None}
+
+# autosummary
+autosummary_generate = True

MANIFEST.in

@@ -0,0 +1,49 @@
+.. include:: ../README.rst
+
+*******
+Modules
+*******
+
+.. autosummary::
+    :toctree: generated
+
+    .. Add/replace module names you want documented here
+    dynamodb_encryption_sdk
+    dynamodb_encryption_sdk.exceptions
+    dynamodb_encryption_sdk.identifiers
+    dynamodb_encryption_sdk.structures
+    dynamodb_encryption_sdk.encrypted
+    dynamodb_encryption_sdk.encrypted.client
+    dynamodb_encryption_sdk.encrypted.item
+    dynamodb_encryption_sdk.encrypted.resource
+    dynamodb_encryption_sdk.encrypted.table
+    dynamodb_encryption_sdk.material_providers
+    dynamodb_encryption_sdk.material_providers.aws_kms
+    dynamodb_encryption_sdk.material_providers.static
+    dynamodb_encryption_sdk.material_providers.wrapped
+    dynamodb_encryption_sdk.material_providers.store
+    dynamodb_encryption_sdk.materials
+    dynamodb_encryption_sdk.materials.raw
+    dynamodb_encryption_sdk.materials.wrapped
+    dynamodb_encryption_sdk.internal
+    dynamodb_encryption_sdk.internal.defaults
+    dynamodb_encryption_sdk.internal.dynamodb_types
+    dynamodb_encryption_sdk.internal.identifiers
+    dynamodb_encryption_sdk.internal.str_ops
+    dynamodb_encryption_sdk.internal.utils
+    dynamodb_encryption_sdk.internal.crypto
+    dynamodb_encryption_sdk.internal.crypto.jce_bridge
+    dynamodb_encryption_sdk.internal.crypto.jce_bridge.authentication
+    dynamodb_encryption_sdk.internal.crypto.jce_bridge.encryption
+    dynamodb_encryption_sdk.internal.crypto.jce_bridge.primitives
+    dynamodb_encryption_sdk.internal.crypto.authentication
+    dynamodb_encryption_sdk.internal.crypto.encryption
+    dynamodb_encryption_sdk.internal.formatting
+    dynamodb_encryption_sdk.internal.formatting.deserialize
+    dynamodb_encryption_sdk.internal.formatting.deserialize.attribute
+    dynamodb_encryption_sdk.internal.formatting.serialize
+    dynamodb_encryption_sdk.internal.formatting.serialize.attribute
+    dynamodb_encryption_sdk.internal.formatting.material_description
+    dynamodb_encryption_sdk.internal.formatting.transform
+
+.. include:: ../CHANGELOG.rst

README.md

@@ -0,0 +1,2 @@
+sphinx>=1.3.0
+sphinx_rtd_theme

README.rst

@@ -0,0 +1,5 @@
+boto3>=1.4.4
+cryptography>=1.8.1
+attrs>=16.3.0
+wrapt>=1.10.11
+typing>=3.6.2

doc/conf.py

@@ -0,0 +1,45 @@
+[wheel]
+universal = 1
+
+[metadata]
+license_file = LICENSE
+
+[coverage:run]
+branch = True
+
+[coverage:report]
+show_missing = True
+
+[mypy]
+ignore_missing_imports = True
+
+[tool:pytest]
+markers =
+    local: superset of unit and functional (does not require network access)
+    unit: mark test as a unit test (does not require network access)
+    functional: mark test as a functional test (does not require network access)
+    integ: mark a test as an integration test (requires network access)
+    slow: mark a test as being known to take a long time to complete (order 5s < t < 60s)
+    veryslow: mark a test as being known to take a very long time to complete (order t > 60s)
+    nope: mark a test as being so slow that it should only be very infrequently (order t > 30m)
+log_level=NOTSET
+
+# Flake8 Configuration
+[flake8]
+max_complexity = 10
+max_line_length = 120
+import_order_style = google
+application_import_names = dynamodb_encryption_sdk
+builtins = raw_input
+ignore =
+    # Ignoring D205 and D400 because of false positives
+    D205, D400,
+    # Ignoring D401 pending discussion of imperative mood
+    D401,
+    # Ignoring D202 (no blank lines after function docstring) because mypy confuses flake8
+    D202
+
+
+# Doc8 Configuration
+[doc8]
+max-line-length = 120

doc/index.rst

@@ -0,0 +1,64 @@
+"""DynamoDB Encryption SDK."""
+import io
+import os
+import re
+
+from setuptools import find_packages, setup
+
+VERSION_RE = re.compile(r'''__version__ = ['"]([0-9.]+)['"]''')
+HERE = os.path.abspath(os.path.dirname(__file__))
+
+
+def read(*args):
+    """Reads complete file contents."""
+    return io.open(os.path.join(HERE, *args), encoding='utf-8').read()
+
+
+def get_version():
+    """Reads the version from this module."""
+    init = read('src', 'dynamodb_encryption_sdk', 'identifiers.py')
+    return VERSION_RE.search(init).group(1)
+
+
+def get_requirements():
+    """Reads the requirements file."""
+    requirements = read('requirements.txt')
+    return [r for r in requirements.strip().splitlines()]
+
+
+setup(
+    name='dynamodb-encryption-sdk',
+    version=get_version(),
+    packages=find_packages('src'),
+    package_dir={'': 'src'},
+    url='http://dynamodb-encryption-sdk.readthedocs.io/en/latest/',
+    author='Amazon Web Services',
+    author_email='[email protected]',
+    maintainer='Amazon Web Services',
+    long_description=read('README.rst'),
+    keywords='aws-encryption-sdk aws kms encryption dynamodb',
+    data_files=[
+        'README.rst',
+        'CHANGELOG.rst',
+        'LICENSE',
+        'requirements.txt'
+    ],
+    license='Apache License 2.0',
+    install_requires=get_requirements(),
+    classifiers=[
+        'Development Status :: 5 - Production/Stable',
+        'Intended Audience :: Developers',
+        'Natural Language :: English',
+        'License :: OSI Approved :: Apache Software License',
+        'Programming Language :: Python',
+        'Programming Language :: Python :: 2',
+        'Programming Language :: Python :: 2.7',
+        'Programming Language :: Python :: 3',
+        'Programming Language :: Python :: 3.4',
+        'Programming Language :: Python :: 3.5',
+        'Programming Language :: Python :: 3.6',
+        'Programming Language :: Python :: Implementation :: CPython',
+        'Topic :: Security',
+        'Topic :: Security :: Cryptography'
+    ]
+)

doc/requirements.txt

@@ -0,0 +1,12 @@
+[BASIC]
+# Allow function names up to 50 characters
+function-rgx = [a-z_][a-z0-9_]{2,50}$
+
+[DESIGN]
+max-args = 10
+
+[FORMAT]
+max-line-length = 120
+
+[REPORTS]
+msg-template = {path}:{line}: [{msg_id}({symbol}), {obj}] {msg}

requirements.txt

@@ -0,0 +1,21 @@
+[MESSAGES CONTROL]
+# Disabling messages that we either don't care about
+# for tests or are necessary to break for tests.
+#
+# C0103 : invalid-name (we prefer long, descriptive, names for tests)
+# C0111 : missing-docstring (we don't write docstrings for tests)
+# E1101 : no-member (raised on patched objects with mock checks)
+# R0801 : duplicate-code (unit tests for similar things tend to be similar)
+# W0212 : protected-access (raised when calling _ methods)
+# W0621 : redefined-outer-name (raised when using pytest-mock)
+# W0613 : unused-argument (raised when patches are needed but not called)
+disable = C0103, C0111, E1101, R0801, W0212, W0621, W0613
+
+[DESIGN]
+max-args = 10
+
+[FORMAT]
+max-line-length = 120
+
+[REPORTS]
+msg-template = {path}:{line}: [{msg_id}({symbol}), {obj}] {msg}