ariatosca-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From emblempar...@apache.org
Subject [1/2] incubator-ariatosca git commit: Initial work on organization and bug fixes
Date Fri, 23 Jun 2017 02:14:10 GMT
Repository: incubator-ariatosca
Updated Branches:
  refs/heads/ARIA-286-sphinx-documentation [created] 66213279b


http://git-wip-us.apache.org/repos/asf/incubator-ariatosca/blob/66213279/aria/storage/core.py
----------------------------------------------------------------------
diff --git a/aria/storage/core.py b/aria/storage/core.py
index 06c29e8..4b0a38f 100644
--- a/aria/storage/core.py
+++ b/aria/storage/core.py
@@ -26,16 +26,17 @@ We define this abstraction with the following components:
 4. field: defines a field/item in the model.
 
 API:
-    * application_storage_factory - function, default ARIA storage factory.
-    * Storage - class, simple storage mapi.
-    * models - module, default ARIA standard models.
-    * structures - module, default ARIA structures - holds the base model,
-                   and different fields types.
-    * Model - class, abstract model implementation.
-    * Field - class, base field implementation.
-    * IterField - class, base iterable field implementation.
-    * drivers - module, a pool of ARIA standard drivers.
-    * StorageDriver - class, abstract model implementation.
+
+* application_storage_factory - function, default ARIA storage factory.
+* Storage - class, simple storage mapi.
+* models - module, default ARIA standard models.
+* structures - module, default ARIA structures - holds the base model,
+               and different fields types.
+* Model - class, abstract model implementation.
+* Field - class, base field implementation.
+* IterField - class, base iterable field implementation.
+* drivers - module, a pool of ARIA standard drivers.
+* StorageDriver - class, abstract model implementation.
 """
 import copy
 from contextlib import contextmanager
@@ -63,12 +64,12 @@ class Storage(LoggerMixin):
                  **kwargs):
         """
 
-        :param api_cls: API cls for each model.
+        :param api_cls: API cls for each model
         :param api_kwargs:
         :param items: the items to register
-        :param initiator: a func which initializes the storage before the first use.
-        This function should return a dict, this dict would be passed in addition to the api kwargs.
-        This enables the creation of any unpickable objects across process.
+        :param initiator: a func which initializes the storage before the first use; this function
+                          should return a dict, this dict would be passed in addition to the API
+                          kwargs; this enables the creation of non-serializable objects
         :param initiator_kwargs:
         :param kwargs:
         """
@@ -113,7 +114,8 @@ class Storage(LoggerMixin):
     def register(self, entry):
         """
         Register the entry to the storage
-        :param name:
+
+        :param entry:
         :return:
         """
         raise NotImplementedError('Subclass must implement abstract register method')
@@ -126,7 +128,8 @@ class ResourceStorage(Storage):
     def register(self, name):
         """
         Register the resource type to resource storage.
-        :param name:
+
+        :param name: name
         :return:
         """
         self.registered[name] = self.api(name=name, **self._all_api_kwargs)
@@ -146,6 +149,7 @@ class ModelStorage(Storage):
     def register(self, model_cls):
         """
         Register the model into the model storage.
+
         :param model_cls: the model to register.
         :return:
         """
@@ -163,6 +167,7 @@ class ModelStorage(Storage):
     def drop(self):
         """
         Drop all the tables from the model.
+
         :return:
         """
         for mapi in self.registered.values():

http://git-wip-us.apache.org/repos/asf/incubator-ariatosca/blob/66213279/aria/storage/sql_mapi.py
----------------------------------------------------------------------
diff --git a/aria/storage/sql_mapi.py b/aria/storage/sql_mapi.py
index bb6223a..f044bd6 100644
--- a/aria/storage/sql_mapi.py
+++ b/aria/storage/sql_mapi.py
@@ -54,7 +54,8 @@ class SQLAlchemyModelAPI(api.ModelAPI):
         self._session = session
 
     def get(self, entry_id, include=None, **kwargs):
-        """Return a single result based on the model class and element ID
+        """
+        Return a single result based on the model class and element ID
         """
         query = self._get_query(include, {'id': entry_id})
         result = query.first()
@@ -102,25 +103,28 @@ class SQLAlchemyModelAPI(api.ModelAPI):
              filters=None,
              sort=None,
              **kwargs):
-        """Return a (possibly empty) list of `model_class` results
+        """
+        Return a (possibly empty) list of ``model_class`` results.
         """
         for result in self._get_query(include, filters, sort):
             yield self._instrument(result)
 
     def put(self, entry, **kwargs):
-        """Create a `model_class` instance from a serializable `model` object
+        """
+        Create a ``model_class`` instance from a serializable ``model`` object
 
-        :param entry: A dict with relevant kwargs, or an instance of a class
-        that has a `to_dict` method, and whose attributes match the columns
-        of `model_class` (might also my just an instance of `model_class`)
-        :return: An instance of `model_class`
+        :param entry: dict with relevant kwargs, or an instance of a class that has a ``to_dict``
+                      method, and whose attributes match the columns of ``model_class`` (might also
+                      be just an instance of ``model_class``)
+        :return: an instance of ``model_class``
         """
         self._session.add(entry)
         self._safe_commit()
         return entry
 
     def delete(self, entry, **kwargs):
-        """Delete a single result based on the model class and element ID
+        """
+        Delete a single result based on the model class and element ID
         """
         self._load_relationships(entry)
         self._session.delete(entry)
@@ -128,17 +132,19 @@ class SQLAlchemyModelAPI(api.ModelAPI):
         return entry
 
     def update(self, entry, **kwargs):
-        """Add `instance` to the DB session, and attempt to commit
+        """
+        Add ``instance`` to the database session, and attempt to commit
 
-        :return: The updated instance
+        :return: updated instance
         """
         return self.put(entry)
 
     def refresh(self, entry):
-        """Reload the instance with fresh information from the DB
+        """
+        Reload the instance with fresh information from the database
 
-        :param entry: Instance to be re-loaded from the DB
-        :return: The refreshed instance
+        :param entry: instance to be re-loaded from the database
+        :return: refreshed instance
         """
         self._session.refresh(entry)
         self._load_relationships(entry)
@@ -161,13 +167,13 @@ class SQLAlchemyModelAPI(api.ModelAPI):
     def drop(self):
         """
         Drop the table from the storage.
-        :return:
         """
         self.model_cls.__table__.drop(self._engine)
 
     def _safe_commit(self):
-        """Try to commit changes in the session. Roll back if exception raised
-        Excepts SQLAlchemy errors and rollbacks if they're caught
+        """
+        Try to commit changes in the session. Roll back if exception raised SQLAlchemy errors and
+        rollbacks if they're caught.
         """
         try:
             self._session.commit()
@@ -179,11 +185,11 @@ class SQLAlchemyModelAPI(api.ModelAPI):
             raise exceptions.StorageError('SQL Storage error: {0}'.format(str(e)))
 
     def _get_base_query(self, include, joins):
-        """Create the initial query from the model class and included columns
+        """
+        Create the initial query from the model class and included columns
 
-        :param include: A (possibly empty) list of columns to include in
-        the query
-        :return: An SQLAlchemy AppenderQuery object
+        :param include: (possibly empty) list of columns to include in the query
+        :return: SQLAlchemy AppenderQuery object
         """
         # If only some columns are included, query through the session object
         if include:
@@ -199,9 +205,10 @@ class SQLAlchemyModelAPI(api.ModelAPI):
 
     @staticmethod
     def _get_joins(model_class, columns):
-        """Get a list of all the tables on which we need to join
+        """
+        Get a list of all the tables on which we need to join
 
-        :param columns: A set of all attributes involved in the query
+        :param columns: set of all attributes involved in the query
         """
 
         # Using a list instead of a set because order is important
@@ -222,12 +229,13 @@ class SQLAlchemyModelAPI(api.ModelAPI):
 
     @staticmethod
     def _sort_query(query, sort=None):
-        """Add sorting clauses to the query
+        """
+        Add sorting clauses to the query
 
-        :param query: Base SQL query
-        :param sort: An optional dictionary where keys are column names to
-        sort by, and values are the order (asc/desc)
-        :return: An SQLAlchemy AppenderQuery object
+        :param query: base SQL query
+        :param sort: optional dictionary where keys are column names to sort by, and values are
+                     the order (asc/desc)
+        :return: SQLAlchemy AppenderQuery object
         """
         if sort:
             for column, order in sort.items():
@@ -237,13 +245,13 @@ class SQLAlchemyModelAPI(api.ModelAPI):
         return query
 
     def _filter_query(self, query, filters):
-        """Add filter clauses to the query
+        """
+        Add filter clauses to the query
 
         :param query: Base SQL query
-        :param filters: An optional dictionary where keys are column names to
-        filter by, and values are values applicable for those columns (or lists
-        of such values)
-        :return: An SQLAlchemy AppenderQuery object
+        :param filters: optional dictionary where keys are column names to filter by, and values
+                        are values applicable for those columns (or lists of such values)
+        :return: SQLAlchemy AppenderQuery object
         """
         return self._add_value_filter(query, filters)
 
@@ -264,17 +272,16 @@ class SQLAlchemyModelAPI(api.ModelAPI):
                    include=None,
                    filters=None,
                    sort=None):
-        """Get an SQL query object based on the params passed
+        """
+        Get an SQL query object based on the params passed
 
         :param model_class: SQL DB table class
-        :param include: An optional list of columns to include in the query
-        :param filters: An optional dictionary where keys are column names to
-        filter by, and values are values applicable for those columns (or lists
-        of such values)
-        :param sort: An optional dictionary where keys are column names to
-        sort by, and values are the order (asc/desc)
-        :return: A sorted and filtered query with only the relevant
-        columns
+        :param include: optional list of columns to include in the query
+        :param filters: optional dictionary where keys are column names to filter by, and values
+                        are values applicable for those columns (or lists of such values)
+        :param sort: optional dictionary where keys are column names to sort by, and values are the
+                     order (asc/desc)
+        :return: sorted and filtered query with only the relevant columns
         """
         include, filters, sort, joins = self._get_joins_and_converted_columns(
             include, filters, sort
@@ -305,9 +312,10 @@ class SQLAlchemyModelAPI(api.ModelAPI):
                                          include,
                                          filters,
                                          sort):
-        """Get a list of tables on which we need to join and the converted
-        `include`, `filters` and `sort` arguments (converted to actual SQLA
-        column/label objects instead of column names)
+        """
+        Get a list of tables on which we need to join and the converted ``include``, ``filters`` and
+        ```sort`` arguments (converted to actual SQLAlchemy column/label objects instead of column
+        names).
         """
         include = include or []
         filters = filters or dict()
@@ -325,8 +333,9 @@ class SQLAlchemyModelAPI(api.ModelAPI):
                                       include,
                                       filters,
                                       sort):
-        """Go over the optional parameters (include, filters, sort), and
-        replace column names with actual SQLA column objects
+        """
+        Go over the optional parameters (include, filters, sort), and replace column names with
+        actual SQLAlechmy column objects.
         """
         include = [self._get_column(c) for c in include]
         filters = dict((self._get_column(c), filters[c]) for c in filters)
@@ -335,9 +344,10 @@ class SQLAlchemyModelAPI(api.ModelAPI):
         return include, filters, sort
 
     def _get_column(self, column_name):
-        """Return the column on which an action (filtering, sorting, etc.)
-        would need to be performed. Can be either an attribute of the class,
-        or an association proxy linked to a relationship the class has
+        """
+        Return the column on which an action (filtering, sorting, etc.) would need to be performed.
+        Can be either an attribute of the class, or an association proxy linked to a relationship
+        in the class.
         """
         column = getattr(self.model_cls, column_name)
         if column.is_attribute:
@@ -354,13 +364,13 @@ class SQLAlchemyModelAPI(api.ModelAPI):
     def _paginate(query, pagination):
         """Paginate the query by size and offset
 
-        :param query: Current SQLAlchemy query object
-        :param pagination: An optional dict with size and offset keys
-        :return: A tuple with four elements:
-        - res ults: `size` items starting from `offset`
-        - the total count of items
-        - `size` [default: 0]
-        - `offset` [default: 0]
+        :param query: current SQLAlchemy query object
+        :param pagination: optional dict with size and offset keys
+        :return: tuple with four elements:
+                 * results: ``size`` items starting from ``offset``
+                 * the total count of items
+                 * ``size`` [default: 0]
+                 * ``offset`` [default: 0]
         """
         if pagination:
             size = pagination.get('size', 0)
@@ -374,8 +384,9 @@ class SQLAlchemyModelAPI(api.ModelAPI):
 
     @staticmethod
     def _load_relationships(instance):
-        """A helper method used to overcome a problem where the relationships
-        that rely on joins aren't being loaded automatically
+        """
+        A helper method used to overcome a problem where the relationships that rely on joins aren't
+        being loaded automatically.
         """
         for rel in instance.__mapper__.relationships:
             getattr(instance, rel.key)
@@ -389,13 +400,15 @@ class SQLAlchemyModelAPI(api.ModelAPI):
 
 def init_storage(base_dir, filename='db.sqlite'):
     """
-    A builtin ModelStorage initiator.
-    Creates a sqlalchemy engine and a session to be passed to the mapi.
+    Built-in ModelStorage initiator.
+
+    Creates a SQLAlchemy engine and a session to be passed to the MAPI.
+
+    ``initiator_kwargs`` must be passed to the ModelStorage which must hold the ``base_dir`` for the
+    location of the database file, and an option filename. This would create an SQLite database.
 
-    Initiator_kwargs must be passed to the ModelStorage which must hold the base_dir for the
-    location of the db file, and an option filename. This would create an sqlite db.
-    :param base_dir: the dir of the db
-    :param filename: the db file name.
+    :param base_dir: directory of the database
+    :param filename: database file name.
     :return:
     """
     uri = 'sqlite:///{platform_char}{path}'.format(
@@ -415,7 +428,7 @@ def init_storage(base_dir, filename='db.sqlite'):
 
 class ListResult(list):
     """
-    a ListResult contains results about the requested items.
+    Contains results about the requested items.
     """
     def __init__(self, metadata, *args, **qwargs):
         super(ListResult, self).__init__(*args, **qwargs)

http://git-wip-us.apache.org/repos/asf/incubator-ariatosca/blob/66213279/aria/utils/__init__.py
----------------------------------------------------------------------
diff --git a/aria/utils/__init__.py b/aria/utils/__init__.py
index ae1e83e..da51070 100644
--- a/aria/utils/__init__.py
+++ b/aria/utils/__init__.py
@@ -12,3 +12,7 @@
 # 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.
+
+"""
+ARIA utilities package
+"""

http://git-wip-us.apache.org/repos/asf/incubator-ariatosca/blob/66213279/aria/utils/archive.py
----------------------------------------------------------------------
diff --git a/aria/utils/archive.py b/aria/utils/archive.py
index 63d9004..3dfb204 100644
--- a/aria/utils/archive.py
+++ b/aria/utils/archive.py
@@ -10,6 +10,9 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
+"""
+ARIA utilities archive module
+"""
 
 import os
 import tarfile

http://git-wip-us.apache.org/repos/asf/incubator-ariatosca/blob/66213279/aria/utils/argparse.py
----------------------------------------------------------------------
diff --git a/aria/utils/argparse.py b/aria/utils/argparse.py
index 365c148..b4ad8ac 100644
--- a/aria/utils/argparse.py
+++ b/aria/utils/argparse.py
@@ -13,6 +13,10 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
+"""
+ARIA utilities argparse module
+"""
+
 from __future__ import absolute_import  # so we can import standard 'argparse'
 
 from argparse import ArgumentParser as BaseArgumentParser

http://git-wip-us.apache.org/repos/asf/incubator-ariatosca/blob/66213279/aria/utils/caching.py
----------------------------------------------------------------------
diff --git a/aria/utils/caching.py b/aria/utils/caching.py
index c9e475a..47aa7c4 100644
--- a/aria/utils/caching.py
+++ b/aria/utils/caching.py
@@ -13,6 +13,10 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
+"""
+ARIA utilities caching module
+"""
+
 from __future__ import absolute_import  # so we can import standard 'collections' and 'threading'
 
 from threading import Lock

http://git-wip-us.apache.org/repos/asf/incubator-ariatosca/blob/66213279/aria/utils/collections.py
----------------------------------------------------------------------
diff --git a/aria/utils/collections.py b/aria/utils/collections.py
index 1e732aa..93c56fa 100644
--- a/aria/utils/collections.py
+++ b/aria/utils/collections.py
@@ -13,6 +13,10 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
+"""
+ARIA utilities collections module
+"""
+
 from __future__ import absolute_import  # so we can import standard 'collections'
 
 from copy import deepcopy

http://git-wip-us.apache.org/repos/asf/incubator-ariatosca/blob/66213279/aria/utils/console.py
----------------------------------------------------------------------
diff --git a/aria/utils/console.py b/aria/utils/console.py
index 55d2529..9c89e5e 100644
--- a/aria/utils/console.py
+++ b/aria/utils/console.py
@@ -13,6 +13,10 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
+"""
+ARIA utilities console module
+"""
+
 from clint.textui.core import STDOUT
 from clint.textui import puts as _puts
 from clint.textui.colored import ColoredString as _ColoredString

http://git-wip-us.apache.org/repos/asf/incubator-ariatosca/blob/66213279/aria/utils/exceptions.py
----------------------------------------------------------------------
diff --git a/aria/utils/exceptions.py b/aria/utils/exceptions.py
index b60cee4..4ecadba 100644
--- a/aria/utils/exceptions.py
+++ b/aria/utils/exceptions.py
@@ -13,6 +13,10 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
+"""
+ARIA utilities exceptions module
+"""
+
 import sys
 import linecache
 import StringIO

http://git-wip-us.apache.org/repos/asf/incubator-ariatosca/blob/66213279/aria/utils/file.py
----------------------------------------------------------------------
diff --git a/aria/utils/file.py b/aria/utils/file.py
index 6d1aa16..06d3f8e 100644
--- a/aria/utils/file.py
+++ b/aria/utils/file.py
@@ -13,6 +13,10 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
+"""
+ARIA utilities file module
+"""
+
 import errno
 import os
 import shutil

http://git-wip-us.apache.org/repos/asf/incubator-ariatosca/blob/66213279/aria/utils/formatting.py
----------------------------------------------------------------------
diff --git a/aria/utils/formatting.py b/aria/utils/formatting.py
index b8d24cd..b35f801 100644
--- a/aria/utils/formatting.py
+++ b/aria/utils/formatting.py
@@ -13,6 +13,10 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
+"""
+ARIA utilities formatting module
+"""
+
 import json
 from types import MethodType
 

http://git-wip-us.apache.org/repos/asf/incubator-ariatosca/blob/66213279/aria/utils/http.py
----------------------------------------------------------------------
diff --git a/aria/utils/http.py b/aria/utils/http.py
index 7bdfd79..580e3e7 100644
--- a/aria/utils/http.py
+++ b/aria/utils/http.py
@@ -13,6 +13,10 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
+"""
+ARIA utilities HTTP module
+"""
+
 import os
 import tempfile
 
@@ -20,17 +24,17 @@ import requests
 
 
 def download_file(url, destination=None, logger=None, progress_handler=None):
-    """Download file.
+    """
+    Download file.
 
     May raise IOError as well as requests.exceptions.RequestException
-    :param url: Location of the file to download
+
+    :param url: location of the file to download
     :type url: str
-    :param destination:
-        Location where the file should be saved (autogenerated by default)
+    :param destination: location where the file should be saved (autogenerated by default)
     :type destination: str | None
     :returns: Location where the file was saved
     :rtype: str
-
     """
     chunk_size = 1024
 

http://git-wip-us.apache.org/repos/asf/incubator-ariatosca/blob/66213279/aria/utils/imports.py
----------------------------------------------------------------------
diff --git a/aria/utils/imports.py b/aria/utils/imports.py
index 35aa0fc..2c9de53 100644
--- a/aria/utils/imports.py
+++ b/aria/utils/imports.py
@@ -14,7 +14,9 @@
 # limitations under the License.
 
 """
-Utility methods for dynamically loading python code
+ARIA utilities imports module
+
+Utility functions for dynamically loading Python code.
 """
 
 import pkgutil

http://git-wip-us.apache.org/repos/asf/incubator-ariatosca/blob/66213279/aria/utils/openclose.py
----------------------------------------------------------------------
diff --git a/aria/utils/openclose.py b/aria/utils/openclose.py
index 19740eb..b04a6d4 100644
--- a/aria/utils/openclose.py
+++ b/aria/utils/openclose.py
@@ -13,6 +13,10 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
+"""
+ARIA utilities open-close module
+"""
+
 class OpenClose(object):
     """
     Wraps an object that has open() and close() methods to support the "with" keyword.

http://git-wip-us.apache.org/repos/asf/incubator-ariatosca/blob/66213279/aria/utils/plugin.py
----------------------------------------------------------------------
diff --git a/aria/utils/plugin.py b/aria/utils/plugin.py
index b7f94a1..58078ae 100644
--- a/aria/utils/plugin.py
+++ b/aria/utils/plugin.py
@@ -13,6 +13,10 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
+"""
+ARIA utilities plugin module
+"""
+
 import wagon
 
 

http://git-wip-us.apache.org/repos/asf/incubator-ariatosca/blob/66213279/aria/utils/process.py
----------------------------------------------------------------------
diff --git a/aria/utils/process.py b/aria/utils/process.py
index 9aeae67..b0e230c 100644
--- a/aria/utils/process.py
+++ b/aria/utils/process.py
@@ -13,6 +13,10 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
+"""
+ARIA utilities process module
+"""
+
 import os
 
 

http://git-wip-us.apache.org/repos/asf/incubator-ariatosca/blob/66213279/aria/utils/specification.py
----------------------------------------------------------------------
diff --git a/aria/utils/specification.py b/aria/utils/specification.py
index e74c103..273897c 100644
--- a/aria/utils/specification.py
+++ b/aria/utils/specification.py
@@ -13,6 +13,10 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
+"""
+ARIA utilities specification module
+"""
+
 from .collections import OrderedDict
 
 

http://git-wip-us.apache.org/repos/asf/incubator-ariatosca/blob/66213279/aria/utils/threading.py
----------------------------------------------------------------------
diff --git a/aria/utils/threading.py b/aria/utils/threading.py
index bfd30f5..5bced68 100644
--- a/aria/utils/threading.py
+++ b/aria/utils/threading.py
@@ -13,6 +13,10 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
+"""
+ARIA utilities threading module
+"""
+
 from __future__ import absolute_import  # so we can import standard 'threading'
 
 import sys

http://git-wip-us.apache.org/repos/asf/incubator-ariatosca/blob/66213279/aria/utils/type.py
----------------------------------------------------------------------
diff --git a/aria/utils/type.py b/aria/utils/type.py
index f08159a..3c48cf5 100644
--- a/aria/utils/type.py
+++ b/aria/utils/type.py
@@ -13,6 +13,10 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
+"""
+ARIA utilities type module
+"""
+
 import datetime
 
 from .specification import implements_specification

http://git-wip-us.apache.org/repos/asf/incubator-ariatosca/blob/66213279/aria/utils/uris.py
----------------------------------------------------------------------
diff --git a/aria/utils/uris.py b/aria/utils/uris.py
index 5f7bcf5..75f376d 100644
--- a/aria/utils/uris.py
+++ b/aria/utils/uris.py
@@ -13,6 +13,10 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
+"""
+ARIA utilities URIs module
+"""
+
 import os
 import urlparse
 

http://git-wip-us.apache.org/repos/asf/incubator-ariatosca/blob/66213279/aria/utils/uuid.py
----------------------------------------------------------------------
diff --git a/aria/utils/uuid.py b/aria/utils/uuid.py
index 1f340c6..fdec879 100644
--- a/aria/utils/uuid.py
+++ b/aria/utils/uuid.py
@@ -13,6 +13,10 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
+"""
+ARIA utilities UUID module
+"""
+
 from __future__ import absolute_import  # so we can import standard 'uuid'
 
 from random import randrange
@@ -32,11 +36,10 @@ def generate_uuid(length=None, variant='base57'):
     """
     A random string with varying degrees of guarantee of universal uniqueness.
 
-    :param variant: options are:
-                    * 'base57' (the default) uses a mix of upper and lowercase alphanumerics
+    :param variant: * 'base57' (the default) uses a mix of upper and lowercase alphanumerics
                       ensuring no visually ambiguous characters; default length 22
                     * 'alphanumeric' uses lowercase alphanumeric; default length 25
-                    * 'uuid' user lowercase hexadecimal in the classic UUID format, including
+                    * 'uuid' uses lowercase hexadecimal in the classic UUID format, including
                       dashes; length is always 36
                     * 'hex' uses lowercase hexadecimal characters but has no guarantee of
                       uniqueness; default length of 5

http://git-wip-us.apache.org/repos/asf/incubator-ariatosca/blob/66213279/aria/utils/validation.py
----------------------------------------------------------------------
diff --git a/aria/utils/validation.py b/aria/utils/validation.py
index 193cb33..8b2bb7d 100644
--- a/aria/utils/validation.py
+++ b/aria/utils/validation.py
@@ -14,6 +14,8 @@
 # limitations under the License.
 
 """
+ARIA utilities validation module
+
 Contains validation related utilities
 """
 

http://git-wip-us.apache.org/repos/asf/incubator-ariatosca/blob/66213279/aria/utils/versions.py
----------------------------------------------------------------------
diff --git a/aria/utils/versions.py b/aria/utils/versions.py
index 925f59e..1e64f47 100644
--- a/aria/utils/versions.py
+++ b/aria/utils/versions.py
@@ -14,6 +14,8 @@
 # limitations under the License.
 
 """
+ARIA utilities version module
+
 General-purpose version string handling
 """
 

http://git-wip-us.apache.org/repos/asf/incubator-ariatosca/blob/66213279/docs/aria.cli.rst
----------------------------------------------------------------------
diff --git a/docs/aria.cli.rst b/docs/aria.cli.rst
new file mode 100644
index 0000000..e1518e8
--- /dev/null
+++ b/docs/aria.cli.rst
@@ -0,0 +1,100 @@
+..
+   Licensed to the Apache Software Foundation (ASF) under one or more
+   contributor license agreements.  See the NOTICE file distributed with
+   this work for additional information regarding copyright ownership.
+   The ASF licenses this file to You 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.
+
+:mod:`aria.cli`
+---------------
+
+.. automodule:: aria.cli
+
+:mod:`aria.cli.color`
+#####################
+
+.. automodule:: aria.cli.color
+
+:mod:`aria.cli.csar`
+####################
+
+.. automodule:: aria.cli.csar
+
+:mod:`aria.cli.defaults`
+########################
+
+.. automodule:: aria.cli.defaults
+
+:mod:`aria.cli.exceptions`
+##########################
+
+.. automodule:: aria.cli.exceptions
+
+:mod:`aria.cli.execution_logging`
+#################################
+
+.. automodule:: aria.cli.execution_logging
+
+:mod:`aria.cli.helptexts`
+#########################
+
+.. automodule:: aria.cli.helptexts
+
+:mod:`aria.cli.inputs`
+######################
+
+.. automodule:: aria.cli.inputs
+
+:mod:`aria.cli.logger`
+######################
+
+.. automodule:: aria.cli.logger
+
+:mod:`aria.cli.main`
+####################
+
+.. automodule:: aria.cli.main
+
+:mod:`aria.cli.service_template_utils`
+######################################
+
+.. automodule:: aria.cli.service_template_utils
+
+:mod:`aria.cli.table`
+#####################
+
+.. automodule:: aria.cli.table
+
+:mod:`aria.cli.utils`
+#####################
+
+.. automodule:: aria.cli.utils
+
+:mod:`aria.cli.config`
+######################
+
+.. automodule:: aria.cli.config
+
+:mod:`aria.cli.config.config`
+#############################
+
+.. automodule:: aria.cli.config.config
+
+:mod:`aria.cli.core`
+####################
+
+.. automodule:: aria.cli.core
+
+:mod:`aria.cli.core.aria`
+#########################
+
+.. automodule:: aria.cli.core.aria

http://git-wip-us.apache.org/repos/asf/incubator-ariatosca/blob/66213279/docs/aria.modeling.models.rst
----------------------------------------------------------------------
diff --git a/docs/aria.modeling.models.rst b/docs/aria.modeling.models.rst
new file mode 100644
index 0000000..13f9494
--- /dev/null
+++ b/docs/aria.modeling.models.rst
@@ -0,0 +1,21 @@
+..
+   Licensed to the Apache Software Foundation (ASF) under one or more
+   contributor license agreements.  See the NOTICE file distributed with
+   this work for additional information regarding copyright ownership.
+   The ASF licenses this file to You 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.
+
+
+:mod:`aria.modeling.models`
+---------------------------
+
+.. automodule:: aria.modeling.models

http://git-wip-us.apache.org/repos/asf/incubator-ariatosca/blob/66213279/docs/aria.modeling.rst
----------------------------------------------------------------------
diff --git a/docs/aria.modeling.rst b/docs/aria.modeling.rst
new file mode 100644
index 0000000..3daa0a0
--- /dev/null
+++ b/docs/aria.modeling.rst
@@ -0,0 +1,51 @@
+..
+   Licensed to the Apache Software Foundation (ASF) under one or more
+   contributor license agreements.  See the NOTICE file distributed with
+   this work for additional information regarding copyright ownership.
+   The ASF licenses this file to You 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.
+
+
+:mod:`aria.modeling`
+--------------------
+
+.. automodule:: aria.modeling
+
+:mod:`aria.modeling.constraints`
+################################
+
+.. automodule:: aria.modeling.constraints
+
+:mod:`aria.modeling.exceptions`
+###############################
+
+.. automodule:: aria.modeling.exceptions
+
+:mod:`aria.modeling.functions`
+##############################
+
+.. automodule:: aria.modeling.functions
+
+:mod:`aria.modeling.mixins`
+###########################
+
+.. automodule:: aria.modeling.mixins
+
+:mod:`aria.modeling.relationship`
+#################################
+
+.. automodule:: aria.modeling.relationship
+
+:mod:`aria.modeling.utils`
+##########################
+
+.. automodule:: aria.modeling.utils

http://git-wip-us.apache.org/repos/asf/incubator-ariatosca/blob/66213279/docs/aria.orchestrator.execution_plugin.rst
----------------------------------------------------------------------
diff --git a/docs/aria.orchestrator.execution_plugin.rst b/docs/aria.orchestrator.execution_plugin.rst
new file mode 100644
index 0000000..8abd0cc
--- /dev/null
+++ b/docs/aria.orchestrator.execution_plugin.rst
@@ -0,0 +1,31 @@
+..
+   Licensed to the Apache Software Foundation (ASF) under one or more
+   contributor license agreements.  See the NOTICE file distributed with
+   this work for additional information regarding copyright ownership.
+   The ASF licenses this file to You 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.
+
+
+:mod:`aria.orchestrator.execution_plugin`
+-----------------------------------------
+
+.. automodule:: aria.orchestrator.execution_plugin
+
+:mod:`aria.orchestrator.execution_plugin.ctx_proxy`
+###################################################
+
+.. automodule:: aria.orchestrator.execution_plugin.ctx_proxy
+
+:mod:`aria.orchestrator.execution_plugin.ssh`
+#############################################
+
+.. automodule:: aria.orchestrator.execution_plugin.ssh

http://git-wip-us.apache.org/repos/asf/incubator-ariatosca/blob/66213279/docs/aria.orchestrator.rst
----------------------------------------------------------------------
diff --git a/docs/aria.orchestrator.rst b/docs/aria.orchestrator.rst
new file mode 100644
index 0000000..962367f
--- /dev/null
+++ b/docs/aria.orchestrator.rst
@@ -0,0 +1,26 @@
+..
+   Licensed to the Apache Software Foundation (ASF) under one or more
+   contributor license agreements.  See the NOTICE file distributed with
+   this work for additional information regarding copyright ownership.
+   The ASF licenses this file to You 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.
+
+
+:mod:`aria.orchestrator`
+------------------------
+
+.. automodule:: aria.orchestrator
+
+:mod:`aria.orchestrator.context`
+################################
+
+.. automodule:: aria.orchestrator.context

http://git-wip-us.apache.org/repos/asf/incubator-ariatosca/blob/66213279/docs/aria.orchestrator.workflows.rst
----------------------------------------------------------------------
diff --git a/docs/aria.orchestrator.workflows.rst b/docs/aria.orchestrator.workflows.rst
new file mode 100644
index 0000000..4e0e50b
--- /dev/null
+++ b/docs/aria.orchestrator.workflows.rst
@@ -0,0 +1,41 @@
+..
+   Licensed to the Apache Software Foundation (ASF) under one or more
+   contributor license agreements.  See the NOTICE file distributed with
+   this work for additional information regarding copyright ownership.
+   The ASF licenses this file to You 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.
+
+
+:mod:`aria.orchestrator.workflows`
+----------------------------------
+
+.. automodule:: aria.orchestrator.workflows
+
+:mod:`aria.orchestrator.workflows.api`
+######################################
+
+.. automodule:: aria.orchestrator.workflows.api
+
+:mod:`aria.orchestrator.workflows.builtin`
+##########################################
+
+.. automodule:: aria.orchestrator.workflows.builtin
+
+:mod:`aria.orchestrator.workflows.core`
+#######################################
+
+.. automodule:: aria.orchestrator.workflows.core
+
+:mod:`aria.orchestrator.workflows.executor`
+###########################################
+
+.. automodule:: aria.orchestrator.workflows.executor

http://git-wip-us.apache.org/repos/asf/incubator-ariatosca/blob/66213279/docs/aria.parser.consumption.rst
----------------------------------------------------------------------
diff --git a/docs/aria.parser.consumption.rst b/docs/aria.parser.consumption.rst
new file mode 100644
index 0000000..d991ad9
--- /dev/null
+++ b/docs/aria.parser.consumption.rst
@@ -0,0 +1,61 @@
+..
+   Licensed to the Apache Software Foundation (ASF) under one or more
+   contributor license agreements.  See the NOTICE file distributed with
+   this work for additional information regarding copyright ownership.
+   The ASF licenses this file to You 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.
+
+
+:mod:`aria.parser.consumption`
+------------------------------
+
+.. automodule:: aria.parser.consumption
+
+:mod:`aria.parser.consumption.consumer`
+#######################################
+
+.. automodule:: aria.parser.consumption.consumer
+
+:mod:`aria.parser.consumption.context`
+######################################
+
+.. automodule:: aria.parser.consumption.context
+
+:mod:`aria.parser.consumption.exceptions`
+#########################################
+
+.. automodule:: aria.parser.consumption.exceptions
+
+:mod:`aria.parser.consumption.inputs`
+#####################################
+
+.. automodule:: aria.parser.consumption.inputs
+
+:mod:`aria.parser.consumption.modeling`
+#######################################
+
+.. automodule:: aria.parser.consumption.modeling
+
+:mod:`aria.parser.consumption.presentation`
+###########################################
+
+.. automodule:: aria.parser.consumption.presentation
+
+:mod:`aria.parser.consumption.style`
+####################################
+
+.. automodule:: aria.parser.consumption.style
+
+:mod:`aria.parser.consumption.validation`
+#########################################
+
+.. automodule:: aria.parser.consumption.validation

http://git-wip-us.apache.org/repos/asf/incubator-ariatosca/blob/66213279/docs/aria.parser.loading.rst
----------------------------------------------------------------------
diff --git a/docs/aria.parser.loading.rst b/docs/aria.parser.loading.rst
new file mode 100644
index 0000000..de57422
--- /dev/null
+++ b/docs/aria.parser.loading.rst
@@ -0,0 +1,66 @@
+..
+   Licensed to the Apache Software Foundation (ASF) under one or more
+   contributor license agreements.  See the NOTICE file distributed with
+   this work for additional information regarding copyright ownership.
+   The ASF licenses this file to You 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.
+
+
+:mod:`aria.parser.loading`
+--------------------------
+
+.. automodule:: aria.parser.loading
+
+:mod:`aria.parser.loading.context`
+##################################
+
+.. automodule:: aria.parser.loading.context
+
+:mod:`aria.parser.loading.exceptions`
+#####################################
+
+.. automodule:: aria.parser.loading.exceptions
+
+:mod:`aria.parser.loading.file`
+###############################
+
+.. automodule:: aria.parser.loading.file
+
+:mod:`aria.parser.loading.literal`
+##################################
+
+.. automodule:: aria.parser.loading.literal
+
+:mod:`aria.parser.loading.loader`
+#################################
+
+.. automodule:: aria.parser.loading.loader
+
+:mod:`aria.parser.loading.location`
+###################################
+
+.. automodule:: aria.parser.loading.location
+
+:mod:`aria.parser.loading.request`
+##################################
+
+.. automodule:: aria.parser.loading.request
+
+:mod:`aria.parser.loading.source`
+#################################
+
+.. automodule:: aria.parser.loading.source
+
+:mod:`aria.parser.loading.uri`
+##############################
+
+.. automodule:: aria.parser.loading.uri

http://git-wip-us.apache.org/repos/asf/incubator-ariatosca/blob/66213279/docs/aria.parser.modeling.rst
----------------------------------------------------------------------
diff --git a/docs/aria.parser.modeling.rst b/docs/aria.parser.modeling.rst
new file mode 100644
index 0000000..62225b6
--- /dev/null
+++ b/docs/aria.parser.modeling.rst
@@ -0,0 +1,26 @@
+..
+   Licensed to the Apache Software Foundation (ASF) under one or more
+   contributor license agreements.  See the NOTICE file distributed with
+   this work for additional information regarding copyright ownership.
+   The ASF licenses this file to You 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.
+
+
+:mod:`aria.parser.modeling`
+---------------------------
+
+.. automodule:: aria.parser.modeling
+
+:mod:`aria.parser.modeling.context`
+###################################
+
+.. automodule:: aria.parser.modeling.context

http://git-wip-us.apache.org/repos/asf/incubator-ariatosca/blob/66213279/docs/aria.parser.presentation.rst
----------------------------------------------------------------------
diff --git a/docs/aria.parser.presentation.rst b/docs/aria.parser.presentation.rst
new file mode 100644
index 0000000..75660e4
--- /dev/null
+++ b/docs/aria.parser.presentation.rst
@@ -0,0 +1,66 @@
+..
+   Licensed to the Apache Software Foundation (ASF) under one or more
+   contributor license agreements.  See the NOTICE file distributed with
+   this work for additional information regarding copyright ownership.
+   The ASF licenses this file to You 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.
+
+
+:mod:`aria.parser.presentation`
+-------------------------------
+
+.. automodule:: aria.parser.presentation
+
+:mod:`aria.parser.presentation.context`
+#######################################
+
+.. automodule:: aria.parser.presentation.context
+
+:mod:`aria.parser.presentation.exceptions`
+##########################################
+
+.. automodule:: aria.parser.presentation.exceptions
+
+:mod:`aria.parser.presentation.field_validators`
+################################################
+
+.. automodule:: aria.parser.presentation.field_validators
+
+:mod:`aria.parser.presentation.fields`
+######################################
+
+.. automodule:: aria.parser.presentation.fields
+
+:mod:`aria.parser.presentation.null`
+####################################
+
+.. automodule:: aria.parser.presentation.null
+
+:mod:`aria.parser.presentation.presentation`
+############################################
+
+.. automodule:: aria.parser.presentation.presentation
+
+:mod:`aria.parser.presentation.presenter`
+#########################################
+
+.. automodule:: aria.parser.presentation.presenter
+
+:mod:`aria.parser.presentation.source`
+######################################
+
+.. automodule:: aria.parser.presentation.source
+
+:mod:`aria.parser.presentation.utils`
+#####################################
+
+.. automodule:: aria.parser.presentation.utils

http://git-wip-us.apache.org/repos/asf/incubator-ariatosca/blob/66213279/docs/aria.parser.reading.rst
----------------------------------------------------------------------
diff --git a/docs/aria.parser.reading.rst b/docs/aria.parser.reading.rst
new file mode 100644
index 0000000..ef32a3d
--- /dev/null
+++ b/docs/aria.parser.reading.rst
@@ -0,0 +1,66 @@
+..
+   Licensed to the Apache Software Foundation (ASF) under one or more
+   contributor license agreements.  See the NOTICE file distributed with
+   this work for additional information regarding copyright ownership.
+   The ASF licenses this file to You 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.
+
+
+:mod:`aria.parser.reading`
+--------------------------
+
+.. automodule:: aria.parser.reading
+
+:mod:`aria.parser.reading.context`
+##################################
+
+.. automodule:: aria.parser.reading.context
+
+:mod:`aria.parser.reading.exceptions`
+#####################################
+
+.. automodule:: aria.parser.reading.exceptions
+
+:mod:`aria.parser.reading.jinja`
+################################
+
+.. automodule:: aria.parser.reading.jinja
+
+:mod:`aria.parser.reading.json`
+###############################
+
+.. automodule:: aria.parser.reading.json
+
+:mod:`aria.parser.reading.locator`
+##################################
+
+.. automodule:: aria.parser.reading.locator
+
+:mod:`aria.parser.reading.raw`
+##############################
+
+.. automodule:: aria.parser.reading.raw
+
+:mod:`aria.parser.reading.reader`
+#################################
+
+.. automodule:: aria.parser.reading.reader
+
+:mod:`aria.parser.reading.source`
+#################################
+
+.. automodule:: aria.parser.reading.source
+
+:mod:`aria.parser.reading.yaml`
+###############################
+
+.. automodule:: aria.parser.reading.yaml

http://git-wip-us.apache.org/repos/asf/incubator-ariatosca/blob/66213279/docs/aria.parser.rst
----------------------------------------------------------------------
diff --git a/docs/aria.parser.rst b/docs/aria.parser.rst
new file mode 100644
index 0000000..f3765d4
--- /dev/null
+++ b/docs/aria.parser.rst
@@ -0,0 +1,31 @@
+..
+   Licensed to the Apache Software Foundation (ASF) under one or more
+   contributor license agreements.  See the NOTICE file distributed with
+   this work for additional information regarding copyright ownership.
+   The ASF licenses this file to You 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.
+
+
+:mod:`aria.parser`
+------------------
+
+.. automodule:: aria.parser
+
+:mod:`aria.parser.exceptions`
+#############################
+
+.. automodule:: aria.parser.exceptions
+
+:mod:`aria.parser.specification`
+################################
+
+.. automodule:: aria.parser.specification

http://git-wip-us.apache.org/repos/asf/incubator-ariatosca/blob/66213279/docs/aria.parser.validation.rst
----------------------------------------------------------------------
diff --git a/docs/aria.parser.validation.rst b/docs/aria.parser.validation.rst
new file mode 100644
index 0000000..3700b56
--- /dev/null
+++ b/docs/aria.parser.validation.rst
@@ -0,0 +1,31 @@
+..
+   Licensed to the Apache Software Foundation (ASF) under one or more
+   contributor license agreements.  See the NOTICE file distributed with
+   this work for additional information regarding copyright ownership.
+   The ASF licenses this file to You 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.
+
+
+:mod:`aria.parser.validation`
+-----------------------------
+
+.. automodule:: aria.parser.validation
+
+:mod:`aria.parser.validation.context`
+#####################################
+
+.. automodule:: aria.parser.validation.context
+
+:mod:`aria.parser.validation.issue`
+###################################
+
+.. automodule:: aria.parser.validation.issue

http://git-wip-us.apache.org/repos/asf/incubator-ariatosca/blob/66213279/docs/aria.rst
----------------------------------------------------------------------
diff --git a/docs/aria.rst b/docs/aria.rst
new file mode 100644
index 0000000..0af98ef
--- /dev/null
+++ b/docs/aria.rst
@@ -0,0 +1,40 @@
+..
+   Licensed to the Apache Software Foundation (ASF) under one or more
+   contributor license agreements.  See the NOTICE file distributed with
+   this work for additional information regarding copyright ownership.
+   The ASF licenses this file to You 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.
+
+:mod:`aria`
+-----------
+
+.. automodule:: aria
+
+:mod:`aria.core`
+################
+
+.. automodule:: aria.core
+
+:mod:`aria.exceptions`
+######################
+
+.. automodule:: aria.exceptions
+
+:mod:`aria.extension`
+#####################
+
+.. automodule:: aria.extension
+
+:mod:`aria.logger`
+##################
+
+.. automodule:: aria.logger

http://git-wip-us.apache.org/repos/asf/incubator-ariatosca/blob/66213279/docs/aria.storage.rst
----------------------------------------------------------------------
diff --git a/docs/aria.storage.rst b/docs/aria.storage.rst
new file mode 100644
index 0000000..8eda2f8
--- /dev/null
+++ b/docs/aria.storage.rst
@@ -0,0 +1,51 @@
+..
+   Licensed to the Apache Software Foundation (ASF) under one or more
+   contributor license agreements.  See the NOTICE file distributed with
+   this work for additional information regarding copyright ownership.
+   The ASF licenses this file to You 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.
+
+
+:mod:`aria.storage`
+-------------------
+
+.. automodule:: aria.storage
+
+:mod:`aria.storage.api`
+#######################
+
+.. automodule:: aria.storage.api
+
+:mod:`aria.storage.collection_instrumentation`
+##############################################
+
+.. automodule:: aria.storage.collection_instrumentation
+
+:mod:`aria.storage.core`
+########################
+
+.. automodule:: aria.storage.core
+
+:mod:`aria.storage.exceptions`
+##############################
+
+.. automodule:: aria.storage.exceptions
+
+:mod:`aria.storage.filesystem_rapi`
+###################################
+
+.. automodule:: aria.storage.filesystem_rapi
+
+:mod:`aria.storage.sql_mapi`
+############################
+
+.. automodule:: aria.storage.sql_mapi

http://git-wip-us.apache.org/repos/asf/incubator-ariatosca/blob/66213279/docs/aria.utils.rst
----------------------------------------------------------------------
diff --git a/docs/aria.utils.rst b/docs/aria.utils.rst
new file mode 100644
index 0000000..7f67d23
--- /dev/null
+++ b/docs/aria.utils.rst
@@ -0,0 +1,121 @@
+..
+   Licensed to the Apache Software Foundation (ASF) under one or more
+   contributor license agreements.  See the NOTICE file distributed with
+   this work for additional information regarding copyright ownership.
+   The ASF licenses this file to You 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.
+
+
+:mod:`aria.utils`
+-----------------
+
+.. automodule:: aria.utils
+
+:mod:`aria.utils.archive`
+#########################
+
+.. automodule:: aria.utils.archive
+
+:mod:`aria.utils.argparse`
+##########################
+
+.. automodule:: aria.utils.argparse
+
+:mod:`aria.utils.caching`
+#########################
+
+.. automodule:: aria.utils.caching
+
+:mod:`aria.utils.collections`
+#############################
+
+.. automodule:: aria.utils.collections
+
+:mod:`aria.utils.console`
+#########################
+
+.. automodule:: aria.utils.console
+
+:mod:`aria.utils.exceptions`
+############################
+
+.. automodule:: aria.utils.exceptions
+
+:mod:`aria.utils.file`
+######################
+
+.. automodule:: aria.utils.file
+
+:mod:`aria.utils.formatting`
+############################
+
+.. automodule:: aria.utils.formatting
+
+:mod:`aria.utils.http`
+######################
+
+.. automodule:: aria.utils.http
+
+:mod:`aria.utils.imports`
+#########################
+
+.. automodule:: aria.utils.imports
+
+:mod:`aria.utils.openclose`
+###########################
+
+.. automodule:: aria.utils.openclose
+
+:mod:`aria.utils.plugin`
+########################
+
+.. automodule:: aria.utils.plugin
+
+:mod:`aria.utils.process`
+#########################
+
+.. automodule:: aria.utils.process
+
+:mod:`aria.utils.specification`
+###############################
+
+.. automodule:: aria.utils.specification
+
+:mod:`aria.utils.threading`
+###########################
+
+.. automodule:: aria.utils.threading
+
+:mod:`aria.utils.type`
+######################
+
+.. automodule:: aria.utils.type
+
+:mod:`aria.utils.uris`
+######################
+
+.. automodule:: aria.utils.uris
+
+:mod:`aria.utils.uuid`
+######################
+
+.. automodule:: aria.utils.uuid
+
+:mod:`aria.utils.validation`
+############################
+
+.. automodule:: aria.utils.validation
+
+:mod:`aria.utils.versions`
+##########################
+
+.. automodule:: aria.utils.versions

http://git-wip-us.apache.org/repos/asf/incubator-ariatosca/blob/66213279/docs/aria_extension_tosca.rst
----------------------------------------------------------------------
diff --git a/docs/aria_extension_tosca.rst b/docs/aria_extension_tosca.rst
new file mode 100644
index 0000000..e984e82
--- /dev/null
+++ b/docs/aria_extension_tosca.rst
@@ -0,0 +1,30 @@
+..
+   Licensed to the Apache Software Foundation (ASF) under one or more
+   contributor license agreements.  See the NOTICE file distributed with
+   this work for additional information regarding copyright ownership.
+   The ASF licenses this file to You 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.
+
+:mod:`aria_extension_tosca`
+---------------------------
+
+.. automodule:: aria_extension_tosca
+
+:mod:`aria_extension_tosca.simple_v1_0`
+#######################################
+
+.. automodule:: aria_extension_tosca.simple_v1_0
+
+:mod:`aria_extension_tosca.simple_nfv_v1_0`
+###########################################
+
+.. automodule:: aria_extension_tosca.simple_nfv_v1_0

http://git-wip-us.apache.org/repos/asf/incubator-ariatosca/blob/66213279/docs/cli.rst
----------------------------------------------------------------------
diff --git a/docs/cli.rst b/docs/cli.rst
new file mode 100644
index 0000000..ee51545
--- /dev/null
+++ b/docs/cli.rst
@@ -0,0 +1,57 @@
+..
+   Licensed to the Apache Software Foundation (ASF) under one or more
+   contributor license agreements.  See the NOTICE file distributed with
+   this work for additional information regarding copyright ownership.
+   The ASF licenses this file to You 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.
+
+CLI
+===
+
+.. click:: aria.cli.main:_aria
+   :prog: aria
+
+.. click:: aria.cli.commands.reset:reset
+   :prog: aria reset
+   :show-nested:
+
+.. click:: aria.cli.commands.plugins:plugins
+   :prog: aria plugins
+   :show-nested:
+
+.. click:: aria.cli.commands.service_templates:service_templates
+   :prog: aria service_templates
+   :show-nested:
+
+.. click:: aria.cli.commands.node_templates:node_templates
+   :prog: aria node_templates
+   :show-nested:
+
+.. click:: aria.cli.commands.services:services
+   :prog: aria services
+   :show-nested:
+
+.. click:: aria.cli.commands.nodes:nodes
+   :prog: aria nodes
+   :show-nested:
+
+.. click:: aria.cli.commands.workflows:workflows
+   :prog: aria workflows
+   :show-nested:
+
+.. click:: aria.cli.commands.executions:executions
+   :prog: aria executions
+   :show-nested:
+
+.. click:: aria.cli.commands.logs:logs
+   :prog: aria logs
+   :show-nested:

http://git-wip-us.apache.org/repos/asf/incubator-ariatosca/blob/66213279/docs/conf.py
----------------------------------------------------------------------
diff --git a/docs/conf.py b/docs/conf.py
index e557f02..330118c 100644
--- a/docs/conf.py
+++ b/docs/conf.py
@@ -15,7 +15,7 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
-# ARIA documentation build configuration file.
+# ARIA TOSCA documentation build configuration file.
 #
 # This file is execfile()d with the current directory set to its
 # containing dir.
@@ -48,7 +48,7 @@ with open('../VERSION') as f:
 # 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']
+extensions = ['sphinx.ext.autodoc', 'sphinx_click.ext']
 
 # Add any paths that contain templates here, relative to this directory.
 templates_path = ['_templates']
@@ -67,9 +67,9 @@ source_suffix = '.rst'
 master_doc = 'index'
 
 # General information about the project.
-project = u'ARIA'
-copyright = u'2016, Apache Software Foundation' # @ReservedAssignment
-author = u'ARIA'
+project = u'ARIA TOSCA'
+copyright = u'2016-2017, Apache Software Foundation' # @ReservedAssignment
+author = u'Apache Software Foundation'
 
 # The version info for the project you're documenting, acts as replacement for
 # |version| and |release|, also used in various other places throughout the
@@ -152,7 +152,7 @@ html_theme = 'sphinx_rtd_theme'
 # The name for this set of Sphinx documents.
 # "<project> v<release> documentation" by default.
 #
-# html_title = u'ARIA v0.1.0'
+# html_title = u'ARIA TOSCA v0.1.0'
 
 # A shorter title for the navigation bar.  Default is the same as html_title.
 #
@@ -252,7 +252,7 @@ html_static_path = ['_static']
 # html_search_scorer = 'scorer.js'
 
 # Output file base name for HTML help builder.
-htmlhelp_basename = 'ARIAdoc'
+htmlhelp_basename = 'ARIATOSCAdoc'
 
 # -- Options for LaTeX output ---------------------------------------------
 
@@ -278,7 +278,7 @@ latex_elements = {
 # (source start file, target name, title,
 #  author, documentclass [howto, manual, or own class]).
 latex_documents = [
-    (master_doc, 'ARIA.tex', u'ARIA',
+    (master_doc, 'ARIATOSCA.tex', u'ARIA TOSCA',
      u'Apache Software Foundation', 'manual'),
 ]
 
@@ -329,8 +329,9 @@ man_pages = [
 # (source start file, target name, title, author,
 #  dir menu entry, description, category)
 texinfo_documents = [
-    (master_doc, 'ARIA', u'ARIA',
-     author, 'ARIA', 'Toolkit for parsing TOSCA.',
+    (master_doc, 'ARIATOSCA', u'ARIA TOSCA',
+     author, 'ARIA TOSCA', 'an open, light, CLI-driven library of orchestration tools that other '
+     'open projects can consume to easily build TOSCA-based orchestration solutions.',
      'Miscellaneous'),
 ]
 

http://git-wip-us.apache.org/repos/asf/incubator-ariatosca/blob/66213279/docs/index.rst
----------------------------------------------------------------------
diff --git a/docs/index.rst b/docs/index.rst
index d915ae6..495a350 100644
--- a/docs/index.rst
+++ b/docs/index.rst
@@ -14,24 +14,58 @@
    See the License for the specific language governing permissions and
    limitations under the License.
 
+User Manual for ARIA TOSCA
+==========================
 
-ARIA API
-========
+`ARIA TOSCA <http://ariatosca.incubator.apache.org/>`__ is an open, light, CLI-driven library of
+orchestration tools that other open projects can consume to easily build
+`TOSCA <https://www.oasis-open.org/committees/tosca/>`__-based orchestration solutions. ARIA is now
+an incubation project at the Apache Software Foundation.  
 
-`ARIA (Agile Reference Implementation of Automation) <http://ariatosca.org/>`__  is a an open,
-light, CLI-driven library of orchestration tools that other open projects can consume to easily
-build `TOSCA <https://www.oasis-open.org/committees/tosca/>`__-based orchestration solutions. It
-supports NFV and hybrid cloud scenarios.
+Interfaces
+----------
 
+.. toctree::
+   :maxdepth: 1
+   :includehidden:
+
+   cli
+
+SDK
+---
+
+Core
+####
+
+.. toctree::
+   :maxdepth: 1
+   :includehidden:
+
+   aria
+   aria.cli
+   aria.modeling
+   aria.modeling.models
+   aria.orchestrator
+   aria.orchestrator.execution_plugin
+   aria.orchestrator.workflows
+   aria.parser
+   aria.parser.consumption
+   aria.parser.loading
+   aria.parser.modeling
+   aria.parser.presentation
+   aria.parser.reading
+   aria.parser.validation
+   aria.storage
+   aria.utils
 
-Packages
---------
+Extensions
+##########
 
 .. toctree::
-   :maxdepth: 2
+   :maxdepth: 1
+   :includehidden:
 
-   parser
-   tosca
+   aria_extension_tosca
 
 
 Indices and Tables

http://git-wip-us.apache.org/repos/asf/incubator-ariatosca/blob/66213279/docs/parser.rst
----------------------------------------------------------------------
diff --git a/docs/parser.rst b/docs/parser.rst
deleted file mode 100644
index 5db02e2..0000000
--- a/docs/parser.rst
+++ /dev/null
@@ -1,56 +0,0 @@
-..
-   Licensed to the Apache Software Foundation (ASF) under one or more
-   contributor license agreements.  See the NOTICE file distributed with
-   this work for additional information regarding copyright ownership.
-   The ASF licenses this file to You 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.
-
-
-`aria.parser` Package
-#####################
-
-This is the core parser API.
-
-:mod:`aria.parser`
-******************
-
-.. automodule:: aria
-
-:mod:`aria.parser.consumption`
-******************************
-
-.. automodule:: aria.parser.consumption
-
-:mod:`aria.parser.modeling`
-***************************
-
-.. automodule:: aria.parser.modeling
-
-:mod:`aria.parser.loading`
-**************************
-
-.. automodule:: aria.parser.loading
-
-:mod:`aria.parser.presentation`
-*******************************
-
-.. automodule:: aria.parser.presentation
-
-:mod:`aria.parser.reading`
-**************************
-
-.. automodule:: aria.parser.reading
-
-:mod:`aria.parser.validation`
-*****************************
-
-.. automodule:: aria.parser.validation

http://git-wip-us.apache.org/repos/asf/incubator-ariatosca/blob/66213279/docs/requirements.txt
----------------------------------------------------------------------
diff --git a/docs/requirements.txt b/docs/requirements.txt
index 976c5b6..a49bb26 100644
--- a/docs/requirements.txt
+++ b/docs/requirements.txt
@@ -11,4 +11,5 @@
 # limitations under the License.
 
 Sphinx>=1.6.2, <2.0.0
-sphinx_rtd_theme>=0.2.4, <1.0.0
+sphinx_rtd_theme>=0.2.4, <2.0.0
+sphinx-click>=1.0.2, <1.1.0

http://git-wip-us.apache.org/repos/asf/incubator-ariatosca/blob/66213279/docs/tosca.rst
----------------------------------------------------------------------
diff --git a/docs/tosca.rst b/docs/tosca.rst
deleted file mode 100644
index c98a4a9..0000000
--- a/docs/tosca.rst
+++ /dev/null
@@ -1,36 +0,0 @@
-..
-   Licensed to the Apache Software Foundation (ASF) under one or more
-   contributor license agreements.  See the NOTICE file distributed with
-   this work for additional information regarding copyright ownership.
-   The ASF licenses this file to You 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.
-
-
-`aria_extension_tosca` Package
-##############################
-
-This is the ARIA TOSCA extension.
-
-:mod:`aria_extension_tosca`
-***************************
-
-.. automodule:: aria_extension_tosca
-
-:mod:`aria_extension_tosca.simple_v1_0`
-***************************************
-
-.. automodule:: aria_extension_tosca.simple_v1_0
-
-:mod:`aria_extension_tosca.simple_nfv_v1_0`
-*******************************************
-
-.. automodule:: aria_extension_tosca.simple_nfv_v1_0

http://git-wip-us.apache.org/repos/asf/incubator-ariatosca/blob/66213279/extensions/aria_extension_tosca/simple_nfv_v1_0/presenter.py
----------------------------------------------------------------------
diff --git a/extensions/aria_extension_tosca/simple_nfv_v1_0/presenter.py b/extensions/aria_extension_tosca/simple_nfv_v1_0/presenter.py
index cd07f42..849fbd7 100644
--- a/extensions/aria_extension_tosca/simple_nfv_v1_0/presenter.py
+++ b/extensions/aria_extension_tosca/simple_nfv_v1_0/presenter.py
@@ -21,8 +21,8 @@ from ..simple_v1_0 import ToscaSimplePresenter1_0
 
 class ToscaSimpleNfvPresenter1_0(ToscaSimplePresenter1_0): # pylint: disable=invalid-name,abstract-method
     """
-    ARIA presenter for the `TOSCA Simple Profile for NFV v1.0 csd03 <http://docs.oasis-open.org
-    /tosca/tosca-nfv/v1.0/csd03/tosca-nfv-v1.0-csd03.html>`__.
+    ARIA presenter for the `TOSCA Simple Profile for NFV v1.0 csd04 <http://docs.oasis-open.org
+    /tosca/tosca-nfv/v1.0/csd04/tosca-nfv-v1.0-csd04.html>`__.
 
     Supported :code:`tosca_definitions_version` values:
 


Mime
View raw message