testcases and doc string added

Author: mshaileshr@gmail.com

.gitignore

@@ -104,10 +104,4 @@ venv.bak/
 
 # mypy
 .mypy_cache/
-
-
 .idea/
-# OS generated files #
-.DS_Store
-.DS_Store?
-.DS_Store

.vscode/launch.json

@@ -0,0 +1,18 @@
+{
+    // Use IntelliSense to learn about possible attributes.
+    // Hover to view descriptions of existing attributes.
+    // For more information, visit: https://go.microsoft.com/fwlink/?linkid=830387
+    "version": "0.2.0",
+    "configurations": [
+        testcase
+   
+
+        {
+            "type": "chrome",
+            "request": "launch",
+            "name": "Launch Chrome against localhost",
+            "url": "http://localhost:8080",
+            "webRoot": "${workspaceFolder}"
+        }
+    ]
+}

.vscode/settings.json

@@ -0,0 +1,16 @@
+{
+    "python.pythonPath": "venv/bin/python3.7",
+    "python.testing.unittestArgs": [
+        "-v",
+        "-s",
+        "./tests",
+        "-p",
+        "*test.py"
+    ],
+    "python.testing.pytestEnabled": true,
+    "python.testing.nosetestsEnabled": false,
+    "python.testing.unittestEnabled": false,
+    "python.testing.pytestArgs": [
+        "tests"
+    ]
+}

contentstack/__init__.py

@@ -8,8 +8,11 @@
 """
 
 import warnings
+import os
+import sys
+sys.path.insert(0, os.path.abspath('.'))
 
-__author__ = 'Contentstack (Shailesh Mishra)'
+__author__ = 'Shailesh Mishra'
 __status__ = 'debug'
 __version__ = '1.0.0'
 __package__ = 'contentstack'

contentstack/config.py

@@ -1,3 +1,9 @@
+import os
+import sys
+import enum
+import logging
+sys.path.insert(0, os.path.abspath('.'))
+
 """
 Config
 contentstack
@@ -6,8 +12,6 @@
 
 """
 
-import logging
-import enum
 
 logging.basicConfig(filename='report.log', format='%(asctime)s - %(message)s', level=logging.INFO)
 logging.getLogger(__name__)
@@ -28,11 +32,16 @@ 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: ContentstackRegion
-        :return: self
+
+        :param region: Region support given for US and EU
+        :return: ContentstackRegion
+
         ==============================
+
         [Example:]
+
         >>> config  = Config().region(region=ContentstackRegion.US)
+
         ==============================
         """
 
@@ -44,20 +53,13 @@ def host(self, host):
 
         """
         The base URL for Content Delivery API is cdn.contentstack.io.
-        host is the domain name or IP address (
-        IPv4) of the host that serves the API. It may include the port number if different from the scheme's default
+        host is the domain name or IP address of the host that serves the API. It may include the 
+        port number if different from the scheme's default
         port (443 for HTTPS).
+        
+        Returns:
+            [Config] -- Config, So we can chain more functions
 
-        Note: contentstack supports HTTPS only
-        :param host: host is the domain name
-        :type host: str
-        :return: self
-        :rtype: Config
-
-        ==============================
-        [Example:]
-        >>> config  = Config().host('api.contentstack.io')
-        ==============================
         """
 
         if host is not None and isinstance(host, str):
@@ -73,11 +75,14 @@ def version(self, version=None):
         :type version: str
         :return: self
         :rtype: Config
+        
         ==============================
+        
         [Example:] The API version (in our case, 'v3') can be found in the URL
 
         >>> config  = Config()
         >>> config.version = 'v3'
+        
         ==============================
         """
 
@@ -91,6 +96,7 @@ def endpoint(self):
 
         """
         :return: url endpoint to make Http requst
+        
         """
         return self.__get_url()
 

contentstack/errors.py

@@ -6,6 +6,9 @@
 
 """
 
+import os
+import sys
+sys.path.insert(0, os.path.abspath('.'))
 
 class Error:
 
@@ -38,10 +41,13 @@ def error_code(self):
         It returns error code from the stack response
         :return: error_code as int
         :rtype: int
+        
         ==============================
+        
         [Example:]
 
-        >>> ode = error.error_code
+        >>> code = error.error_code
+
         ==============================
         """
         return self.__error_code
@@ -53,10 +59,13 @@ def error_message(self):
         Returns error_message from the stack response
         :return: error_message
         :rtype: str
+
         ==============================
+
         [Example:]
 
-        >>> ode = error.error_message
+        >>> message = error.error_message
+
         ==============================
         """
 
@@ -69,10 +78,13 @@ def error(self):
         This returns error code and error_message in dict formats
         :return: error dict
         :rtype: dict
+
         ==============================
+
         [Example:]
 
         >>> ode = error.error
+
         ==============================
         """
 
@@ -85,10 +97,13 @@ def error_info(self) -> dict:
         error information
         :return: error information
         :rtype: dict
+
         ==============================
+
         [Example:]
 
         >>> ode = error.error_info
+        
         ==============================
         """
         return self.__error_dict

contentstack/utils.py

@@ -15,11 +15,11 @@ class NullHandler(logging.Handler):
         def emit(self, record):
             pass
 
-logging.basicConfig(filename='contentstack.log', format='%(asctime)s - %(message)s', level=logging.INFO)
+logging.basicConfig(filename='report_log.log', format='%(asctime)s - %(message)s', level=logging.INFO)
 logging.getLogger("Config")
 
 
-def log(message: str):
+def log(message):
     logging.debug(message)