doc string added

Author: mshaileshr@gmail.com

CHANGELOGS.md

@@ -1,3 +1,4 @@
 
-##v0.0.1
+## version 0.0.1 - beta release
+
 Initial release of the python Content Delivery API SDK.

contentstack/__init__.py

@@ -7,9 +7,6 @@
 """
 
 import warnings
-import os
-import sys
-sys.path.insert(0, os.path.abspath('.'))
 
 __author__ = 'contentstack'
 __status__ = 'debug'

contentstack/config.py

@@ -1,8 +1,5 @@
-import os
-import sys
 import enum
 import logging
-sys.path.insert(0, os.path.abspath('.'))
 
 """
 Config
@@ -26,32 +23,44 @@ class Config(object):
 
     def __init__(self):
 
-        """
-
+        """Config class arguments accepts protocol, region, host and version:
+        
+        protocol: It support https protocol only
+        region: It accepts us and eu region.
+        host: host of the stack
+        version: API version, contentstack support v3 API version
+        
         """
         self.default = dict(protocol="https", region=ContentstackRegion.US, host="cdn.contentstack.io", version="v3")
 
     @property
     def region(self):
-        """ :returns  region of the stack """
+
+        """It sets the region in the API, We support us and eu region
+        default region will be us.
+        
+        Returns:
+            ContentstackRegion -- It returns type of ContentstackRegion
+        """
         return self.default['region']
 
     @region.setter
     def region(self, region=ContentstackRegion.US):
 
         """
-        The base URL for Content Delivery API is cdn.contentstack.io.
-        default region is for ContentstackRegion is US
-
-        :param region: Region support given for US and EU
-        :return: ContentstackRegion
+        A Contentstack region refers to the location of the data centers where your organization's data resides.
+        
+        Keyword Arguments:
+            region {ContentstackRegion} -- region refers to the location of the data centers where your organization's data resides. (default: {ContentstackRegion.US})
 
+        For more details: https://www.contentstack.com/docs/guide/contentstack-regions
+        
         ==============================
 
         [Example:]
 
-        >>> config = Config()
-        >>> config.region = ContentstackRegion.US
+            >>> config = Config()
+            >>> config.region = ContentstackRegion.US
 
         ==============================
         """
@@ -63,6 +72,12 @@ def region(self, region=ContentstackRegion.US):
     @property
     def host(self):
 
+        """host property returns host of the API
+        
+        Returns:
+            str -- host of the API
+        """
+
         return self.default['host']
 
     @host.setter
@@ -74,9 +89,20 @@ def host(self, host):
         port number if different from the scheme's default
         port (443 for HTTPS).
         
+        Arguments:
+            host {str} -- host of the stack
+        
         Returns:
             [Config] -- Config, So we can chain more functions
 
+        ==============================
+        
+        [Example:] 
+
+            >>> config  = Config()
+            >>> config.host = 'cdn.contentstack.io'
+        
+        ==============================
         """
 
         if host is not None and isinstance(host, str):
@@ -85,21 +111,23 @@ def host(self, host):
     def version(self, version=None):
 
         """
-        Note: Only version 3 is supported on the CDN. If you're still using version 2 (which we recommend you should
-        not), switch to the CDN version for even faster loading.
-        :param version: The API version can be found in the URL that is basePath
-        :type version: str
-        :return: self
-        :rtype: Config
+        Only version v3 is supported on the CDN.
         
+        Keyword Arguments:
+            version {str} -- version of the API (default: {None})
+        
+        Returns:
+            Config -- class instance to chain the functions
+
         ==============================
         
-        [Example:] The API version (in our case, 'v3') can be found in the URL
+        [Example:] 
 
-        >>> config  = Config()
-        >>> config.version = 'v3'
+            >>> config = Config()
+            >>> config = config.version('v3')
         
         ==============================
+
         """
 
         if version is not None and isinstance(version, str):
@@ -110,9 +138,14 @@ def version(self, version=None):
     @property
     def endpoint(self):
 
-        """
-        :return: url endpoint to make Http requst
+        """It returns endpoint url of the API
+        The base URL for Content Delivery API for the US region is cdn.contentstack.io. and  
+        for the European region it is  eu-cdn.contentstack.com
+        For more details: https://www.contentstack.com/docs/apis/content-delivery-api/#base-url
         
+        Returns:
+            str -- endpoint url of the API
+
         """
         return self.__get_url()
 

contentstack/contentstack.py

@@ -4,16 +4,28 @@
 Copyright 2019 Contentstack. All rights reserved.
 
 """
-import stack
 
 
 class contentstack(object):
 
     """
-    :param api_key: api_key of your target stack.
-    :param access_token: access token for the stack.
-    :param environment: environment of the stack
-    :param config: (optional) contains configuration of the stack
+    Below arguments are needed to initialise stack
+    
+    Arguments:
+        api_key {[type]} -- api_key of your target stack.
+        access_token {[type]} -- access token for the stack.
+        environment {[type]} -- environment of the stack
+        config {[type]} -- (optional) contains configuration of the stack
+    
+    Returns:
+        stack -- stack 
+
+    ==============================
+
+        Example:
+            >>> stack = contentstack.stack.Stack("api_key", "access_token", "environment_name")
+
+    ==============================
     """
 
     @staticmethod

contentstack/errors.py

@@ -1,67 +1,74 @@
+
 """
-Error
-contentstack
+
 Created by Shailesh Mishra on 22/06/19.
 Copyright 2019 Contentstack. All rights reserved.
 
-"""
+contentstack.error
+~~~~~~~~~~~~~~~~~~
 
-import os
-import sys
+API Reference: https://www.contentstack.com/docs/apis/content-delivery-api/#error
 
-sys.path.insert(0, os.path.abspath('.'))
+"""
 
 
 class Error:
+    
     """
-    >>> error = Error()
-    ~~~~~~~~~~~~~~~~~~
     This module implements the Error class.
+    
     API Reference: https://www.contentstack.com/docs/apis/content-delivery-api/#error
 
     """
 
     def __init__(self):
+
         self.__error_dict = {}
         self.__error_code = str
         self.__msg = str
 
     def _config(self, result: dict):
+        
+        # _instance is the protected member of the asset, So outsiders can not access this file.
         if result is not None and len(result) > 0:
             self.__error_dict = result
             self.__error_code = self.__error_dict['error_code']
             self.__msg = self.__error_dict['error_message']
+
         return self
 
     @property
     def error_code(self):
-        """
-        It returns error code from the stack response
-        :return: error_code as int
-        :rtype: int
+        """It returns error code from the stack response
+        
+        Returns:
+            int -- error_code as int
         
         ==============================
         
         [Example:]
 
-        >>> code = Error.error_code
+        >>> error_code = error.error_code
 
         ==============================
+
         """
         return self.__error_code
 
     @property
     def error_message(self):
+
         """
         Returns error_message from the stack response
-        :return: error_message
-        :rtype: str
+
+        Returns:
+            str -- error_message from the stack response
 
         ==============================
 
         [Example:]
 
-        >>> message = Error.error_message
+        >>> message = error.error_message
 
         ==============================
         """
@@ -70,16 +77,18 @@ def error_message(self):
 
     @property
     def error(self):
+
         """
-        This returns error code and error_message in dict formats
-        :return: error dict
-        :rtype: dict
+        error property returns error code and error_message in dict formats
+
+        Returns:
+            dict -- error code and error_message in dict formats
 
         ==============================
 
         [Example:]
 
-        >>> ode = Error.error
+        >>> error = error.error
 
         ==============================
         """
@@ -88,16 +97,17 @@ def error(self):
 
     @property
     def error_info(self) -> dict:
-        """
-        error information
-        :return: error information
-        :rtype: dict
+
+        """error information
+
+        Returns:
+            dict -- error information
 
         ==============================
 
         [Example:]
 
-        >>> ode = Error.error_info
+        >>> ode = error.error_info
         
         ==============================
         """

requirements.txt

@@ -1 +1,2 @@
 requests==2.22.0
+sphinx_rtd_theme