⚡ general clean up

Author: ishaileshmishra

.talismanrc

@@ -0,0 +1 @@
+threshold: medium

CHANGELOG.md

@@ -1,10 +1,21 @@
 # CHANGELOG
 
+## _v1.6.0_
+
+============
+
+### **Date: 11-Aug-2021**
+
+Live Preview support added.
+
+- Stack.live_preview_query function added in Stack
+- live preview funtions added in config
+
 ## _v1.5.1_
 
 ============
 
-### Date: 1-Aug-2021
+### **Date: 1-Aug-2021**
 
 Issue #17 resolved.
 Stack.sync_init uses wrong parameter names
@@ -13,20 +24,22 @@ Stack.sync_init uses wrong parameter names
 
 ============
 
-### Date: 22-Jul-2021
+### **Date: 22-Jul-2021**
 
 contentstack-utils updated to v1.1.0
 
 ## _v1.4.0_
 
 ============
 
-### Date: 05-Apr-2021
+### **Date: 05-Apr-2021**
 
-Entry - include_embedded_objects support added
-Query - include_embedded_objects support added
+Entry
+    - include_embedded_objects support added
+Query
+    - include_embedded_objects support added
 
----
+-----------------------------
 
 ## _v1.3.0_
 
@@ -37,7 +50,7 @@ Date: 26-Feb-2021
 - Retry policy and timeout support included
 - Set default timeout 30 sec
 
----
+-----------------------------
 
 ## _v1.2.0_
 
@@ -57,7 +70,7 @@ Date: 08-Dec-2020
 - Query
   - added support for include_fallback.
 
----
+-----------------------------
 
 ## _v1.1.0_
 
@@ -67,7 +80,7 @@ EntryQueryable
 
 - updated include_reference function.
 
----
+-----------------------------
 
 ## _v1.0.0_
 
@@ -91,12 +104,12 @@ Query
 
 - Changes incorporated in the Query class.
 
----
+-----------------------------
 
 ## _v0.1.0_
 
 November-18, 2019 -beta release
 
 Initial release for the contentstack-python-sdk for Content Delivery API
 
----
+-----------------------------

README.md

@@ -0,0 +1,141 @@
+#
+
+[![Contentstack](https://www.contentstack.com/docs/static/images/contentstack.png)](https://www.contentstack.com/)
+
+<!-- ![Python package](https://github.com/contentstack/contentstack-python/workflows/Python%20package/badge.svg?branch=master) -->
+
+![build](https://img.shields.io/badge/build-passing-green?style=plastic)
+![Coverage](https://raw.githubusercontent.com/contentstack/contentstack-python/b4edf799276f586dce3e57fa5502036cd5fd8da3/coverage.svg) ![pip](https://img.shields.io/badge/pip-v1.6.0-blue?style=plastic) ![python](https://img.shields.io/badge/python-3.5|3.6|3.7|3.8-blue?style=plastic) [![GitHub license](https://img.shields.io/github/license/contentstack/contentstack-python?style=plastic)](https://github.com/contentstack/contentstack-python/blob/master/LICENSE) [![GitHub stars](https://img.shields.io/github/stars/contentstack/contentstack-python?style=plastic)](https://github.com/contentstack/contentstack-python/stargazers)
+
+## Python SDK for Contentstack
+
+Contentstack is a headless CMS with an API-first approach. It is a CMS that developers can use to build powerful cross-platform applications in their favorite languages. Build your application frontend, and Contentstack will take care of the rest. [`Read More`](https://www.contentstack.com/).
+
+Contentstack provides Python SDK to build application on top of Python. Given below is the detailed guide and helpful resources to get started with our Python SDK.
+
+### Prerequisite
+
+You will need python 3 installed on your machine. You can install it from [here](https://www.python.org/ftp/python/3.7.4/python-3.7.4-macosx10.9.pkg).
+
+### Setup and Installation
+
+To use the Contentstack Python SDK to your existing project, perform the steps given below:
+
+### Install contentstack pip
+
+```pyhton
+pip install contentstack
+```
+
+This is the preferred method to install contentstack, as it will always install the most recent stable release. If you don't have [`pip`](https://pip.pypa.io/) installed, this [`Python installation guide`](http://docs.python-guide.org/en/latest/starting/installation/) can guide you through the process
+
+### Key Concepts for using Contentstack
+
+#### Stack
+
+A stack is like a container that holds the content of your app. Learn more about [`Stacks`](https://www.contentstack.com/docs/developers/set-up-stack).
+
+#### Content Type
+
+Content type lets you define the structure or blueprint of a page or a section of your digital property. It is a form-like page that gives Content Managers an interface to input and upload content. [`Read more`](https://www.contentstack.com/docs/developers/create-content-types).
+
+#### Entry
+
+An entry is the actual piece of content created using one of the defined content types. Learn more about [`Entries`](https://www.contentstack.com/docs/content-managers/work-with-entries).
+
+#### Asset
+
+Assets refer to all the media files (images, videos, PDFs, audio files, and so on) uploaded to Contentstack. These files can be used in multiple entries. Read more about [`Assets`](https://www.contentstack.com/docs/content-managers/work-with-assets).
+
+#### Environment
+
+A publishing environment corresponds to one or more deployment servers or a content delivery destination where the entries need to be published. Learn how to work with [`Environments`](https://www.contentstack.com/docs/developers/set-up-environments).
+
+### Contentstack Python SDK: 5-minute Quickstart
+
+#### Initializing your SDK
+
+To initialize the SDK, specify application API key, access token, and environment name of the stack as shown in the snippet given below, You can provide optional parameters for config:
+
+```python
+stack = contentstack.Stack('api_key','delivery_token','environment')
+```
+
+To get the API credentials mentioned above, log in to your Contentstack account and then in your top panel navigation, go to Settings &gt; Stack to view the API Key and Access Token.
+
+#### Querying content from your stack
+
+To retrieve a single entry from a content type use the code snippet given 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()
+```
+
+##### Get Multiple Entries
+
+To retrieve multiple entries of a particular content type, use the code snippet given below:
+
+```python
+stack = contentstack.Stack('api_key','delivery_token','environment')
+query = stack.content_type("content_type_uid").query()
+result = query.find()
+```
+
+### Advanced Queries
+
+You can query for content types, entries, assets and more using our Python API Reference.
+
+[Python API Reference Doc](https://www.contentstack.com/docs/platforms/python/api-reference/)
+
+### Working with Images
+
+We have introduced Image Delivery APIs that let you retrieve images and then manipulate and optimize them for your digital properties. It lets you perform a host of other actions such as crop, trim, resize, rotate, overlay, and so on.
+
+For example, if you want to crop an image (with width as 300 and height as 400), you simply need to append query parameters at the end of the image URL, such as, `https://images.contentstack.io/v3/assets/download?crop=300,400`. There are several more parameters that you can use for your images.
+
+[`Read Image Delivery API documentation`](https://www.contentstack.com/docs/platforms/python/api-reference/).
+
+You can use the Image Delivery API functions in this SDK as well. Here are a few examples of its usage in the SDK.
+
+```python
+image = stack.image_transform(url, {'quality': 100}).get_url()
+image = stack.image_transform(url, {'width': 100, 'height': 100}).get_url()
+image = stack.image_transform(url, {'auto': 'webp'}).get_url()
+```
+
+### Using the Sync API with Python SDK
+
+The Sync API takes care of syncing your Contentstack data with your application and ensures that the data is always up-to-date by providing delta updates. Contentstack’s Python SDK supports Sync API, which you can use to build powerful applications.
+
+```python
+stack = contentstack.Stack('api_key','delivery_token','environment') #initialize sync
+response = stack.sync_init() #sycn using sync token
+response = stack.sync_token('sync_token') #sycn using pagination token
+response = stack.pagination('pagination_token') #sync using multiple parameters
+response = stack.sync_init(publish_type='entry_published', content_type_uid='content_type_uid')
+```
+
+Read through to understand how to use the Sync API with Contentstack Python SDK.
+
+[`Using the Sync API with Python SDK`](https://www.contentstack.com/docs/developers/python/using-the-sync-api-with-python-sdk)
+
+### Helpful Links
+
+- [`Contentstack Website`](https://www.contentstack.com)
+- [`Official Documentation`](https://contentstack.com/docs)
+- [`Content Delivery API Docs`](https://www.contentstack.com/docs/developers/apis/content-delivery-api/)
+
+### The MIT License (MIT)
+
+Copyright © 2012-2021 [`Contentstack`](https://www.contentstack.com/). All Rights Reserved
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+
+- [`Content Delivery API Docs`](https://contentstack.com/docs/apis/content-delivery-api/)

README.rst

@@ -0,0 +1,144 @@
+================
+**Contentstack**
+================
+
+Python SDK for Contentstack
+===========================
+
+  Contentstack is a headless CMS with an API-first approach. It is a CMS that developers can use to build powerful cross-platform applications in their favorite languages. Build your application frontend, and Contentstack will take care of the rest. `Read More <https://www.contentstack.com/>`_.
+
+  Contentstack provides Python SDK to build an application on top of Python. Given below is the detailed guide and helpful resources to get started with our Python SDK.
+
+Prerequisite
+============
+
+  You will need python 3 installed on your machine. You can install it from `here <https://www.python.org/ftp/python/3.7.4/python-3.7.4-macosx10.9.pkg>`_
+
+Setup and Installation
+======================
+
+  To use the Contentstack Python SDK to your existing project, perform the steps given below:
+
+.. code-block:: python
+    install contentstack pip
+
+This is the preferred method to install contentstack, as it will always install the most recent stable release. If you don't have `pip <https://pip.pypa.io/>`_
+installed, this `Python installation guide <http://docs.python-guide.org/en/latest/starting/installation/>`_ can guide you through the process
+
+
+Key Concepts for using Contentstack
+-----------------------------------
+
+**Stack**
+
+  A stack is like a container that holds the content of your app. Learn more about `Stacks <https://www.contentstack.com/docs/developers/set-up-stack>`_.
+
+**Content-Type**
+
+  Content-type lets you define the structure or blueprint of a page or a section of your digital property. It is a form-like page that gives Content Managers an interface to input and upload content. `read_more <https://www.contentstack.com/docs/developers/create-content-types>`_.
+
+**Entry**
+
+    An entry is the actual piece of content created using one of the defined content types. Learn more about `Entries <https://www.contentstack.com/docs/content-managers/work-with-entries>`_.
+
+**Asset**
+
+    Assets refer to all the media files (images, videos, PDFs, audio files, and so on) uploaded to Contentstack. These files can be used in multiple entries. Read more about `Assets <https://www.contentstack.com/docs/content-managers/work-with-assets>`_.
+
+**Environment**
+
+    A publishing environment corresponds to one or more deployment servers or a content delivery destination where the entries need to be published. Learn how to work with `Environments <https://www.contentstack.com/docs/developers/set-up-environments)>`_.
+
+
+
+Contentstack Python SDK: 5-minute Quickstart
+--------------------------------------------
+
+**Initializing your SDK**
+
+    To initialize the SDK, specify the application  API key, access token, and environment name of the stack as shown in the snippet given below:
+
+.. code-block:: python
+
+   stack = contentstack.Stack('api_key', 'delivery_token', 'environment')
+
+
+To get the API credentials mentioned above, log in to your Contentstack account and then in your top panel navigation, go to Settings &gt; Stack to view the API Key and Access Token.
+
+
+
+**Querying content from your stack**
+
+To retrieve a single entry from a content type use the code snippet given below:
+
+.. code-block:: python
+
+   content_type = stack.content_type("content_type_uid")
+   entry = content_type.entry("entry_uid")
+   result = entry.fetch()
+
+
+**Get Multiple Entries**
+
+To retrieve multiple entries of a particular content type, use the code snippet given below:
+
+
+**stack is an instance of Stack class**
+
+.. code-block:: python
+
+   query = stack.content_type("content_type_uid").query()
+   result = query.find()
+
+**Advanced Queries**
+
+     You can query for content types, entries, assets, and more using our Java API Reference. `Python API Reference Doc <https://www.contentstack.com/docs/platforms/python/api-reference/>`_
+
+
+**Working with Images**
+
+    We have introduced Image Delivery APIs that let you retrieve images and then manipulate and optimize them for your digital properties. It lets you perform a host of other actions such as crop, trim, resize, rotate, overlay, and so on.
+
+*For example:*
+
+    If you want to crop an image (with a width of 300 and height of 400), you simply need to append query parameters at the end of the image URL, such as
+
+.. code-block:: python
+
+   https://images.contentstack.io/v3/assets/download?crop=300,400
+
+
+There are several more parameters that you can use for your images. `Read Image Delivery API documentation <https://www.contentstack.com/docs/platforms/python/api-reference/>`_
+
+You can use the Image Delivery API functions in this SDK as well. Here are a few examples of its usage in the SDK.
+
+.. code-block:: python
+
+   url = stack.image_transform(image_url, {'quality': 100})
+   url = stack.image_transform(imageUrl, {'width': 100, 'height': 100})
+   url = stack.image_transform(imageUrl, {'auto': 'webp'})
+
+**Using the Sync API with Python SDK**
+
+    The Sync API takes care of syncing your Contentstack data with your application and ensures that the data is always up-to-date by providing delta updates. Contentstack’s Python SDK supports Sync API, which you can use to build powerful applications.
+
+Read through to understand how to use the Sync API with Contentstack Python SDK. `Using the Sync API with Python SDK <https://www.contentstack.com/docs/developers/python/using-the-sync-api-with-python-sdk>`_
+
+
+**Helpful Links**
+
+  `Contentstack Website <https://www.contentstack.com>`_
+
+  `Official Documentation <https://www.contentstack.com/docs/developers/apis/content-delivery-api/>`_
+
+  `Content Delivery API Docs <https://www.contentstack.com/docs/developers/apis/content-delivery-api>`_.
+
+
+The MIT License (MIT)
+^^^^^^^^^^^^^^^^^^^^^
+
+    Copyright © 2012-2020 Contentstack. All Rights Reserved Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+    
+    The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+    
+    *THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE*

changelog.rst

@@ -2,6 +2,15 @@
 **CHANGELOG**
 ================
 
+*v1.6.0*
+============
+
+**Date: 11-Aug-2021**
+
+Live Preview support added.
+- Stack.live_preview_query function added in Stack
+- live preview functions added in config
+
 *v1.5.1*
 ============