Merge pull request #37 from Covata/flatten-package-#31

Flatten package #31

docs/api.rst

@@ -12,51 +12,13 @@
    See the License for the specific language governing permissions and
    limitations under the License.
 
-API
-====
-
-The `covata.delta.api` module provides a set of tools for executing REST
-calls to Delta API.
-
-DeltaApiClient
---------------
+API Client
+==========
 
 The Delta API Client is an abstraction over the Delta API for execution of
 requests and responses.
 
 .. currentmodule:: covata.delta
 
-.. autoclass:: DeltaApiClient
-   :members:
-
-.. currentmodule:: covata.delta.api
-
-Requests ApiClient
-~~~~~~~~~~~~~~~~~~
-
-An implementation of ``DeltaApiClient`` abstract base class using ``Requests``.
-
-.. autoclass:: RequestsApiClient
-   :show-inheritance:
-   :members:
-
-CVTSigner
----------
-
-The Delta CVT Signer is a utility class for signing outbound requests using
-the CVT1 signing scheme.
-
-.. autoclass:: CVTSigner
-   :members:
-
-RequestsCVTSigner
-~~~~~~~~~~~~~~~~~
-
-An authentication interceptor for ``Requests`` library.
-This interceptor generates and inserts an Authorization header into the
-request based on the CVT1 signing scheme. A date header will also be added
-to the request.
-
-.. autoclass:: RequestsCVTSigner
-   :show-inheritance:
+.. autoclass:: ApiClient
    :members:

docs/crypto.rst

@@ -20,27 +20,3 @@ The Delta Crypto package provides functionality for client side cryptography.
 
 .. automodule:: covata.delta.crypto
     :members:
-
-DeltaKeyStore
--------------
-
-The ``DeltaKeyStore`` provides the interface for a key-storage
-backend of choice.
-
-.. currentmodule:: covata.delta
-
-.. autoclass:: DeltaKeyStore
-    :members:
-
-FileSystemKeyStore
-~~~~~~~~~~~~~~~~~~
-
-Implementation of the ``DeltaKeyStore`` abstract base class using the file
-system. Private keys are saved in the file system as encrypted PEM formats
-and are only decrypted in memory on read.
-
-.. currentmodule:: covata.delta.crypto
-
-.. autoclass:: FileSystemKeyStore
-    :show-inheritance:
-    :members:

docs/index.rst

@@ -22,12 +22,13 @@ Welcome to Covata Delta Python SDK's documentation!
 ===================================================
 
 .. toctree::
-    :maxdepth: 2
+    :maxdepth: 4
     :caption: Contents:
 
     get_started
     api
     crypto
+    keystore
 
 Indices and tables
 ==================

docs/keystore.rst

@@ -0,0 +1,38 @@
+.. Copyright 2017 Covata Limited or its affiliates
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.
+
+
+KeyStore
+========
+
+The ``DeltaKeyStore`` provides the interface for a key-storage
+backend of choice.
+
+.. currentmodule:: covata.delta.keystore
+
+.. autoclass:: DeltaKeyStore
+    :members:
+
+File-System KeyStore
+--------------------
+
+Implementation of the ``DeltaKeyStore`` abstract base class using the file
+system. Private keys are saved in the file system as encrypted PEM formats
+and are only decrypted in memory on read.
+
+.. currentmodule:: covata.delta.keystore
+
+.. autoclass:: FileSystemKeyStore
+    :show-inheritance:
+    :members:

src/main/python/covata/delta/__init__.py

@@ -14,7 +14,9 @@
 
 from __future__ import absolute_import
 
-from .interfaces import DeltaApiClient, DeltaKeyStore
+from .apiclient import ApiClient
+from .keystore import DeltaKeyStore
+from .keystore import FileSystemKeyStore
 from .utils import LogMixin
 
-__all__ = ["DeltaApiClient", "DeltaKeyStore", "LogMixin"]
+__all__ = ["ApiClient", "FileSystemKeyStore", "LogMixin", "DeltaKeyStore"]