README.md updated

Author: shaileshmishra

.gitignore

@@ -31,6 +31,8 @@ MANIFEST
 .idea
 .vscode
 .report.log
+env
+venv
 
 # PyInstaller
 #  Usually these files are written by a python script from a template

README.md

@@ -0,0 +1,103 @@
+# Contentstack Utility
+
+This guide will help you get started with Contentstack Python Utils SDK to build apps powered by Contentstack.
+
+## Prerequisites
+
+The latest version of [PyCharm](https://www.jetbrains.com/pycharm/download/) or [Visual Studio Code](https://code.visualstudio.com/download)
+
+[Python 3](https://docs.python-guide.org/starting/installation/#python-3-installation-guides)
+
+[Create virtual environment](https://packaging.python.org/guides/installing-using-pip-and-virtual-environments/#creating-a-virtual-environment)
+
+[Activate virtual environment](https://packaging.python.org/guides/installing-using-pip-and-virtual-environments/#activating-a-virtual-environment)
+
+## SDK Installation and Setup
+
+To set up Python Utils SDK, Go to terminal and locate the virtual environment path and type below.
+
+```python
+   pip install contentstack_utils
+```
+
+If you are using Contentstack Python SDK in your project by running the following commands,  then “contentstack_utils”  is already imported into your project.
+
+## For the latest version
+
+```python
+   pip install Contentstack
+```
+
+## For the specific version
+
+```python
+   pip install Contentstack==1.3.0
+```
+
+## Usage
+
+Let’s learn how you can use Utils SDK to render embedded items. 
+
+### Create Render Option
+
+To render embedded items on the front-end, use the renderContents function, and define the UI elements you want to show in the front-end of your website, as shown in the example code below:
+
+```python
+   
+   Utils.renderContents(rteArray, localJsonObj, (embedded_object, metadata) -> {
+         
+         switch (metadata.get_style_type()) {
+
+            case BLOCK:
+               title = embedded_object['title']
+               multi_line = embedded_object['title']
+               return '<p>'+title+'</p><span>'+multi_line+'</span>'
+
+            case INLINE:
+               title_inline = embedded_object['title']
+               ml_inline = embedded_object['multi_line']
+               return ¸<p>'+title_inline+'</p><span>'+ml_inline+'</span>'
+
+            case LINKED:
+               title_linked = embedded_object['title']
+               ml_linked = embedded_object['multi_line']
+               return '<p>'+title_linked+'</p><span>'+ml_linked+'</span>'
+            
+            case DISPLAYABLE:
+               title_diplayable = embedded_object['title']
+               ml_diplayable = embedded_object['multi_line']
+               return '<p>'+title_diplayable+'</p><span>'+ml_diplayable+ '</span>'
+            
+            default:
+               return null;
+         }
+   });
+
+```
+
+## Basic Queries
+
+Contentstack Utils SDK lets you interact with the Content Delivery APIs and retrieve embedded items from the RTE field of an entry.
+
+## Fetch Embedded Item(s) from a Single Entry
+
+To get an embedded item of a single entry, you need to provide the stack API key, environment name, content type’s UID, and entry’s UID. Then, use the `entry.fetch` function as shown below:
+
+```python
+   stack = contentstack.Stack('api_key','delivery_token','environment')
+   content_type = stack.content_type("content_type_uid")
+   entry = content_type.entry("entry_uid")
+   result = entry.fetch()
+```
+
+## Fetch Embedded Item(s) from Multiple Entries
+
+To get embedded items from multiple entries, you need to provide the stack API key, delivery token, environment name, and content type’s UID. 
+
+```python
+   stack = contentstack.Stack('api_key','delivery_token','environment')
+   query = stack.content_type("content_type_uid").query()
+   result = query.find()
+```
+
+Fetch entry/entries and Render RTE using GraphQL and ‘@contentstack_utils’ SDK

contentstack/__init__.py

@@ -0,0 +1,28 @@
+# pip install -r requirements.txt
+# pytest --html=tests/report/test-report.html
+
+"""
+The __init__.py files are required to make Python treat the directories as containing
+packages; this is done to prevent directories with a common name, such as string,
+from unintentionally hiding valid modules that occur later on the module search path
+Used: Safety checks your installed dependencies for known security vulnerabilities
+file __init__.py contains package information like
+
+__author__, __status__, __version__, __endpoint__ and __email__
+
+`Your code has been rated at 10.00/10`
+"""
+
+from contentstack_utils.embedded.item_type import ItemType
+from contentstack_utils.embedded.styletype import StyleType
+from contentstack_utils.helper.metadata import Metadata
+from contentstack_utils.render.default_options import DefaultOptions
+from contentstack_utils.render.options import OptionsCallback
+from contentstack_utils.utils import Utils
+
+__title__ = 'contentstack_utils'
+__author__ = 'contentstack'
+__status__ = 'debug'
+__version__ = '0.0.1'
+__endpoint__ = 'cdn.contentstack.io'
+__email__ = 'shailesh.mishra@contentstack.com'

contentstack/embedded/item_type.py

@@ -0,0 +1,20 @@
+"""
+ItemType is Enumeration class that conatains two options for ItemType:
+
+ASSET
+
+ENTRY
+"""
+
+import enum
+
+
+class ItemType(enum.Enum):
+    """
+    Contains Two option for ItemsType
+
+    ENTRY
+    ASSET
+    """
+    ENTRY = 'entry'
+    ASSET = 'asset'

contentstack/helper/metadata.py

@@ -1,4 +1,5 @@
 """"
+There are two types StyleType ENTRY and ASSETS
 For `Entry`: StyleType.BLOCK, StyleType.INLINE, StyleType.LINKED,
 For `Assets`: StyleType.DISPLAY, StyleType.DOWNLOADABLE
  """
@@ -7,6 +8,16 @@
 
 class StyleType(enum.Enum):
 
+    """
+    This StyleType contains four options like below.
+
+    BLOCK
+    INLINE
+    LINK
+    DISPLAY
+    DOWNLOADABLE
+    """
+
     BLOCK = "block"
     INLINE = 'inline'
     LINK = 'link'

contentstack_utils/__init__.py

@@ -0,0 +1,125 @@
+"""
+    Metadata is the model class for embedded objects
+
+    Returns:
+        str: text, item_type, item_uid, type_uid, style_type, outer_html and attributes
+"""
+
+import enum
+
+
+# pylint: disable=too-many-arguments
+class StyleType(enum.Enum):
+    """
+        This StyleType contains four options like below.
+
+        BLOCK
+        INLINE
+        LINK
+        DISPLAY
+        DOWNLOADABLE
+    """
+
+    BLOCK = "block"
+    INLINE = 'inline'
+    LINK = 'link'
+    DISPLAY = 'displayable'
+    DOWNLOADABLE = 'downloadable'
+
+
+class Metadata:
+    """
+    model helper class to set and get value
+    """
+
+    def __init__(self, text: str, item_type: str, item_uid: str,
+                 content_type_uid: str, style_type: StyleType,
+                 outer_html: str, attributes: str):
+        """Used to set the value to the variables
+
+        Args:
+            text (str): [text for embedded objects]
+            item_type (str): [item_type for embedded objects]
+            item_uid (str): [item_uid for embedded objects]
+            content_type_uid (str): [content_type_uid for embedded objects]
+            style_type (StyleType): [style_type for embedded objects]
+            outer_html (str): [outer_html for embedded objects]
+            attributes (str): [attributes for embedded objects]
+        """
+        self.text = text
+        self.item_type = item_type
+        self.item_uid = item_uid
+        self.content_type_uid = content_type_uid
+        self.style_type = style_type
+        self.outer_html = outer_html
+        self.attributes = attributes
+
+    # getter get_text() method
+    @property
+    def get_text(self):
+        """retruns text for embedded objects
+
+        Returns:
+            str : text for embedded objects
+        """
+        return self.text
+
+    # getter get_item_type() method
+    @property
+    def get_item_type(self):
+        """retruns item_type for embedded objects
+
+        Returns:
+            str :  item_type for embedded objects
+        """
+        return self.item_type
+
+    # getter get_item_uid() method
+    @property
+    def get_item_uid(self):
+        """retruns item_uid for embedded objects
+
+        Returns:
+            str : item_uid for embedded objects
+        """
+        return self.item_uid
+
+    # getter get_content_type_uid() method
+    @property
+    def get_content_type_uid(self):
+        """retruns content_type_uid for embedded objects
+
+        Returns:
+            str :  content_type_uid for embedded objects
+        """
+        return self.content_type_uid
+
+    # getter get_style_type() method
+    @property
+    def get_style_type(self):
+        """retruns style_type for embedded objects
+
+        Returns:
+            StyleType :  style_type for embedded objects
+        """
+        return self.style_type
+
+    # getter get_outer_html() method
+    @property
+    def get_outer_html(self):
+        """retruns outer_html for embedded objects
+
+        Returns:
+            str :  outer_html for embedded objects
+        """
+        return self.outer_html
+
+    # getter get_attributes() method
+    @property
+    def get_attributes(self):
+        """ retruns attributes for embedded objects
+
+        Returns:
+            str :  attributes for embedded objects
+        """
+        return self.attributes