Merge pull request #13 from contentstack/include_fallback

Publish content fallback

Author: ishaileshmishra

CHANGELOG.md

@@ -1,19 +1,44 @@
 # CHANGELOG
 
-Date: 10-Aug-2020 - include_reference issue fixed
+
+## _v1.2.0_
+============
+
+_Date: 08-Dec-2020_
+
+- include_fallback Support Added
+- Timeout support included
+
+- Entry 
+   - added support for include_fallback.
+- Asset
+   - added support for include_fallback.
+- AssetQueryable
+   - added support for include_fallback.
+- Query
+   - added support for include_fallback.
+
+-----------------------------
+
+
+
 
 ## _v1.1.0_
 
+_Date: 10-Aug-2020 - include_reference issue fixed_
+
 EntryQueryable
 
 - updated include_reference function.
 
 -----------------------------
 
-Date: 17-Jun-2020 - initial release
+
 
 ## _v1.0.0_
 
+_Date: 17-Jun-2020 - initial release_
+
 Stack
 
 - Initialisation of stack has been modified
@@ -34,11 +59,10 @@ Query
 
 -----------------------------
 
-Date: 18-Nov-2019 - beta release
 
 ## _v0.1.0_
 
-November-18, 2019 -beta release
+_November-18, 2019 -beta release_
 
 Initial release for the contentstack-python-sdk for Content Delivery API
 

changelog.rst

@@ -1,39 +1,65 @@
-=========
-CHANGELOG
-=========
+================
+**CHANGELOG**
+================
+
+ENHANCEMENT, NEW FEATURE, BUG RESOLVE
+
+*v1.2.0*
+============
+
+**Date: 20-Oct-2020**
+
+- **include_fallback support added**
+`entry`
+ - added support for include_fallback.
+`asset`
+ - added support for include_fallback.
+`assetquery`
+ - added support for include_fallback.
+`query`
+ - added support for include_fallback.
+
+- **Timeout support included**
+
+============
+
 
-Date: 10-Aug-2020 - include_reference issue fixed
 
 *v1.1.0*
 ============
 
-EntryQueryable
-    - updated include_reference function.
+**Date: 10-Aug-2020 :: include_reference issue fixed**
+
+**EntryQueryable**
+ - updated include_reference function.
 
 ============
 
-Date: 17-Jun-2020 - initial release
 
 *v1.0.0*
 ============
 
-Stack
+**Date: 17-Jun-2020 :: Initial Release**
+
+**Stack**
     - Initialization of the stack has been modified
     - External config support moved to stack initialization optional parameters
 
-Asset
+**Asset**
     - changes incorporated in Asset class.
 
-Entry
+**Entry**
     - changes incorporated in the entry class.
 
-Query
+**Query**
     - Changes incorporated in the Query class.
 
 -----------------------------
 
-Date: 18-Nov-2019 - beta release
 
 *v0.0.1*
 ============
+
+**Date: 18-Nov-2019 :: Beta Release**
+
 - Beta release for the contentstack-python SDK for Content Delivery API

contentstack/__init__.py

@@ -14,11 +14,10 @@
 from .https_connection import HTTPSConnection
 from .stack import Stack
 from .utility import Utils
-# from contentstack import *
 
 __title__ = 'contentstack-python'
 __author__ = 'Contentstack'
 __status__ = 'debug'
-__version__ = '1.1.0'
+__version__ = '1.2.0'
 __endpoint__ = 'cdn.contentstack.io'
 __email__ = '[email protected]'

contentstack/assetquery.py

@@ -19,7 +19,7 @@ class AssetQuery(BaseQuery):
     def __init__(self, http_instance):
         super().__init__()
         self.http_instance = http_instance
-        self.__query_params = {}
+        self.asset_query_params = {}
         self.base_url = "{}/assets".format(self.http_instance.endpoint)
         if "environment" in self.http_instance.headers:
             env = self.http_instance.headers["environment"]
@@ -62,7 +62,7 @@ def version(self, version):
             >>> result = stack.asset_query().version(3).find()
         ------------------------------
         """
-        self.__query_params["version"] = version
+        self.asset_query_params["version"] = version
         return self
 
     def include_dimension(self):
@@ -79,7 +79,7 @@ def include_dimension(self):
             >>> result = stack.asset_query().include_dimension().find()
         ------------------------------
         """
-        self.__query_params["include_dimension"] = "true"
+        self.asset_query_params["include_dimension"] = "true"
         return self
 
     def relative_url(self):
@@ -95,7 +95,41 @@ def relative_url(self):
             >>> result = stack.asset_query().relative_url().find()
         ------------------------------
         """
-        self.__query_params["relative_urls"] = "true"
+        self.asset_query_params["relative_urls"] = "true"
+        return self
+
+    def include_fallback(self):
+        """Retrieve the published content of the fallback locale if an
+        entry is not localized in specified locale.
+
+        :return: AssetQuery, so we can chain the call
+
+        ----------------------------
+        Example::
+
+            >>> import contentstack
+            >>> stack = contentstack.Stack('api_key', 'delivery_token', 'environment')
+            >>> result = stack.asset_query().include_fallback().find()
+        ----------------------------
+        """
+        self.asset_query_params['include_fallback'] = 'true'
+        return self
+
+    def locale(self, locale: str):
+        """Enter locale code. e.g., en-us
+        This retrieves published entries of specific locale..
+
+        :return: AssetQuery, so we can chain the call
+
+        ----------------------------
+        Example::
+
+            >>> import contentstack
+            >>> stack = contentstack.Stack('api_key', 'delivery_token', 'environment')
+            >>> result = stack.asset_query().locale('en-us').find()
+        ----------------------------
+        """
+        self.asset_query_params['locale'] = locale
         return self
 
     def find(self):
@@ -115,6 +149,6 @@ def find(self):
 
         """
         if self.parameters is not None and len(self.parameters) > 0:
-            self.__query_params["query"] = json.dumps(self.parameters)
-        url = Utils.get_complete_url(self.base_url, self.__query_params)
+            self.asset_query_params["query"] = json.dumps(self.parameters)
+        url = Utils.get_complete_url(self.base_url, self.asset_query_params)
         return self.http_instance.get(url)

contentstack/basequery.py

@@ -165,7 +165,7 @@ def query(self, key: str, value):
             key {str} -- key of the query param
             value {any} -- value of query param
         Raises:
-            KeyError: when key or value found None
+            `KeyError`: when key or value found None
         Returns:
             self-- Class instance, So that method chaining can be performed
         """

contentstack/contenttype.py

@@ -5,7 +5,7 @@
 content type.
 """
 
-# ************* Module asset **************
+# ************* Module ContentType **************
 # Your code has been rated at 10.00/10 by pylint
 
 from urllib import parse

contentstack/entryqueryable.py

@@ -4,6 +4,10 @@
 """
 
 
+# ************* Module EntryQueryable **************
+# Your code has been rated at 10/10 by pylint
+
+
 class EntryQueryable:
     """
     This class is base class for the Entry and Query class that shares common functions
@@ -73,7 +77,6 @@ def excepts(self, field_uid: str):
 
     def include_reference(self, field_uid):
         """
-        **Include Reference:**
         When you fetch an entry of a content type that has a reference field,
         by default, the content of the referred entry is not fetched.
         It only fetches the UID of the referred entry, along with the content of
@@ -112,9 +115,7 @@ def include_content_type(self):
             >>> entry = content_type.entry('uid')
             >>> entry.include_content_type()
             >>> result = entry.fetch()
-
         -------------------------------
-
         [Example: for Query:]
 
             >>> import contentstack
@@ -178,3 +179,4 @@ def add_param(self, key: str, value: str):
         """
         if None not in (key, value):
             self.entry_queryable_param[key] = value
+        return self

contentstack/https_connection.py

@@ -7,7 +7,8 @@
 
 import platform
 from json import JSONDecodeError
-
+from requests.adapters import HTTPAdapter
+from requests.packages.urllib3.util.retry import Retry
 import requests
 from requests.exceptions import Timeout, HTTPError
 
@@ -54,7 +55,12 @@ def get(self, url):
         """
         try:
             self.headers.update(user_agents())
-            response = requests.get(url, verify=True, headers=self.headers)
+            session = requests.Session()
+            retry = Retry(connect=3, backoff_factor=0.5)
+            adapter = HTTPAdapter(max_retries=retry)
+            session.mount('https://', adapter)
+            response = session.get(url, verify=True, headers=self.headers)
+            # response = requests.get(url, verify=True, headers=self.headers)
             response.encoding = 'utf-8'
             return response.json()
         except Timeout:

contentstack/utility.py

@@ -6,7 +6,7 @@
 """
 
 # ************* Module utility checked using pylint **************
-# Your code has been rated at 10.00/10 (previous run: 10.00/10, +0.00)
+# Your code has been rated at 10.00/10
 
 
 import json
@@ -63,7 +63,8 @@ def do_url_encode(params):
 
     @staticmethod
     def get_complete_url(base_url: str, params: dict):
-        """ creates complete url using base_url and their respective parameters
+        """
+        creates complete url using base_url and their respective parameters
         :param base_url:
         :param params:
         :return: