- removed print() from tests directory

- changelog.rst latest version date updated

Author: ishaileshmishra

README.md

@@ -7,13 +7,17 @@
 
 ## 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 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.
+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).
+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
 
@@ -27,48 +31,61 @@ pip install contentstack
 
 Install latest [contentstack](https://pypi.org/project/Contentstack) package from the [PyPI](https://pypi.org)
 
-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
+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).
+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).
+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).
+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).
+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).
+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:
+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')
+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 > Stack to view the API Key and Access Token.
+To get the API credentials mentioned above, log in to your Contentstack account and then in your top panel navigation,
+go to Settings > 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')
+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()
@@ -79,7 +96,7 @@ result = entry.fetch()
 To retrieve multiple entries of a particular content type, use the code snippet given below:
 
 ```python
-stack = contentstack.Stack('api_key','delivery_token','environment')
+stack = contentstack.Stack('api_key', 'delivery_token', 'environment')
 query = stack.content_type("content_type_uid").query()
 result = query.find()
 ```
@@ -92,9 +109,12 @@ You can query for content types, entries, assets and more using our Python API R
 
 ### 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.
+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.
+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/).
 
@@ -108,13 +128,15 @@ 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.
+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
+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')
 ```
 
@@ -132,10 +154,17 @@ Read through to understand how to use the Sync API with Contentstack Python SDK.
 
 Copyright © 2012-2023 [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:
+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 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.
+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/)

changelog.rst

@@ -5,11 +5,12 @@
 *v1.8.0*
 ============
 
-**Date: 09-MAY-2023**
+**Date: 10-MAY-2023**
 
-- AZURE_EU, region support added
-- include_metadata support added to asset, entry and query
+- AZURE_EU, Region support added
+- Include Metadata support added to asset, entry and query
 - General code improvement clean up
+- Changes done for Live Preview
 
 
 *v1.7.0*

contentstack/contenttype.py

@@ -118,7 +118,5 @@ def find(self, params=None):
         encoded_params = parse.urlencode(self.local_param)
         endpoint = self.http_instance.endpoint
         url = f'{endpoint}/content_types?{encoded_params}'
-        # url = '{}?{}'.format(
-        #     '{}/content_types'.format(self.http_instance.endpoint), encoded_params)
         result = self.http_instance.get(url)
         return result

contentstack/entry.py

@@ -194,4 +194,12 @@ def fetch(self):
             self.entry_param.update(self.entry_queryable_param)
         encoded_string = parse.urlencode(self.entry_param, doseq=True)
         url = f'{self.base_url}?{encoded_string}'
+        self._validate_live_preview()
         return self.http_instance.get(url)
+
+    def _validate_live_preview(self):
+        lp = self.http_instance.live_preview
+        if 'content_type_uid' in lp and lp['content_type_uid'] is not None:
+            if lp['content_type_uid'] != str(self.content_type_id):
+                self.http_instance.live_preview['enable'] = False
+        pass

contentstack/https_connection.py

@@ -60,8 +60,16 @@ def __init__(self, endpoint, headers, timeout, retry_strategy, live_preview):
             self.retry_strategy = retry_strategy
             self.live_preview = live_preview
 
+    def impl_live_preview(self):
+        if self.live_preview['enable']:
+            print(self.live_preview)
+            # Get all the params from live preview and make a request,
+            # get the data and merger it to the base response
+        pass
+
     def get(self, url):
         self.headers.update(user_agents())
         adapter = HTTPAdapter(max_retries=self.retry_strategy)
         self.session.mount('https://', adapter)
+        self.impl_live_preview()
         return get_request(self.session, url, headers=self.headers, timeout=self.timeout)

contentstack/query.py

@@ -319,24 +319,31 @@ def __execute_network_call(self):
             self.query_params["query"] = json.dumps(self.parameters)
         if 'environment' in self.http_instance.headers:
             self.query_params['environment'] = self.http_instance.headers['environment']
-        self.__validate_live_preview()
         encoded_string = parse.urlencode(self.query_params, doseq=True)
         url = f'{self.base_url}?{encoded_string}'
         if self.http_instance.live_preview['enable']:
             if self.http_instance.live_preview['content_type_uid'] == self.content_type_uid:
                 _rq = self.http_instance.get(url)['entries']
                 _preview = self.http_instance.live_preview['resp']
                 return self._merge_preview(_rq, _preview)
+        self._validate_live_preview()
         return self.http_instance.get(url)
 
-    def _merge_preview(self, qresp, _preview):
-        if isinstance(qresp, dict):
-            if 'uid' in qresp and qresp['uid'] == _preview['uid']:
-                merged = {**qresp, **_preview}  # TODO: Check merging is properly written or not
-            else:
-                for key in dict.keys():
-                    qresp[key] = self._merge_preview(qresp[key])
-        elif isinstance(qresp, list):
-            for index, it in enumerate(qresp):
-                qresp[index] = self._merge_preview(it, _preview)
-        return qresp
+    def _validate_live_preview(self):
+        lp = self.http_instance.live_preview
+        if 'content_type_uid' in lp and lp['content_type_uid'] is not None:
+            if lp['content_type_uid'] != str(self.content_type_uid):
+                self.http_instance.live_preview['enable'] = False
+        pass
+
+    # def _merge_preview(self, qresp, _preview):
+    #     if isinstance(qresp, dict):
+    #         if 'uid' in qresp and qresp['uid'] == _preview['uid']:
+    #             merged = {**qresp, **_preview}  # TODO: Check merging is properly written or not
+    #         else:
+    #             for key in dict.keys():
+    #                 qresp[key] = self._merge_preview(qresp[key])
+    #     elif isinstance(qresp, list):
+    #         for index, it in enumerate(qresp):
+    #             qresp[index] = self._merge_preview(it, _preview)
+    #     return qresp

contentstack/stack.py

@@ -62,12 +62,12 @@ def __init__(self, api_key: str, delivery_token: str, environment: str,
 
         ```python
     live_preview = {
-              'enable': True,
+            'enable': True,
+            'host': 'api.contentstack.io',
             'authorization': 'your_management_token',
-            'host': 'api.contentstack.com',
             'include_edit_tags': True,
             'edit_tags_type': object | str,
-    }
+            }
         ```
         :param retry_strategy: (optional) custom retry_strategy can be set.
         Method to create retry_strategy: create object of Retry() and provide the
@@ -77,12 +77,10 @@ def __init__(self, api_key: str, delivery_token: str, environment: str,
         >>> _strategy = Retry(total=5, backoff_factor=1, status_forcelist=[408, 429])
         >>> import contentstack
         >>> stack = contentstack.Stack("api_key", "delivery_token", "environment",
-        live_preview={enable=True, authorization='your auth token'}, retry_strategy= _strategy)
+                live_preview={enable=True, authorization='your auth token'}, retry_strategy= _strategy)
         ```
         """
         logging.basicConfig(level=logging.DEBUG)
-        if live_preview is None:
-            live_preview = {'enable': False}
         self.headers = {}
         self._query_params = {}
         self.sync_param = {}
@@ -98,7 +96,6 @@ def __init__(self, api_key: str, delivery_token: str, environment: str,
         self.branch = branch
         self.retry_strategy = retry_strategy
         self.live_preview = live_preview
-
         self._validate_stack()
 
     def _validate_stack(self):
@@ -344,36 +341,24 @@ def live_preview_query(self, **kwargs):
             for key, value in kwargs.iteritems():
                 print "%s = %s" % (key, value)
             Uses:=>
-            live_preview_query(
-                host='api.contentstack.io',
-                entry_uid='your_entry_uid',
-                hash='hashcode'
+        live_preview_query (
+                'enable': True,
+                'live_preview': '#*#*#*#*#',
+                'host': 'your_host',
+                'content_type_uid': 'product',
+                'entry_uid': 'your_entry_uid',
+                'authorization': 'management_token'
                 )
         """
-        self.live_preview.update(kwargs)
-        self._execute_management_api()
-        return self
-
-    def _execute_management_api(self):
-        _headers, _endpoint = self._enable_live_preview()
-        content_type_uid = self.live_preview.get("content_type_uid")
-        _entry_uid = self.live_preview.get("entry_uid")
-        _url = f'{_endpoint}/content_types/{content_type_uid}/entries/{_entry_uid}'
-        import requests
-        r = requests.get(url=_url, verify=True, headers=_headers)
-        if r.ok:
-            self.live_preview['resp'] = r.json()['entry']
-        else:
-            print(r.status_code)
+        if self.live_preview is not None and self.live_preview['enable']:
+            query = kwargs['live_preview']
+            if query is not None:
+                self.live_preview['live_preview'] = query['live_preview']
+            else:
+                self.live_preview['live_preview'] = 'init'
+
+            if 'content_type_uid' in self.live_preview and self.live_preview['content_type_uid'] is not None:
+                self.live_preview['content_type_uid'] = query['content_type_uid']
+            if 'entry_uid' in self.live_preview and self.live_preview['entry_uid'] is not None:
+                self.live_preview['entry_uid'] = query['entry_uid']
         return self
-
-    def _enable_live_preview(self):
-        if isinstance(self.live_preview, dict) and not None:
-            _endpoint = None
-            _local_headers = {}
-            if 'enable' in self.live_preview and self.live_preview['enable']:
-                _local_headers['authorization'] = self.live_preview['authorization']
-                _host = self.live_preview['host']
-                _endpoint = f'https://{_host}/{self.version}'
-                _local_headers['api_key'] = self.headers['api_key']
-            return _local_headers, _endpoint