1.0.0

Author: mshaileshr@gmail.com

changelog.rst

@@ -0,0 +1,29 @@
+=========
+CHANGELOG
+=========
+
+*Date: 18-Jun-2020 - initial release*
+
+**v1.0.0**
+============
+
+- **Stack**
+    - Added support for whereIn(String key) and whereNotIn(String key) methods in Query
+
+- **Assets**
+    - changes for where function that accepts QueryOptions.
+
+- **Entry**
+    - changes for where function that accepts QueryOptions.
+
+- **Query**
+    - changes for where function that accepts QueryOptions.
+
+
+-----------------------------
+
+*Date: 18-Nov-2019 - beta release*
+
+**v0.0.1**
+============
+- Beta release for the contentstack-python SDK for Content Delivery API

contentstack/assetquery.py

@@ -1,5 +1,4 @@
-"""
-This call fetches the list of all the assets of a particular stack.
+r"""This call fetches the list of all the assets of a particular stack.
 It also returns the content of each asset in JSON format.
 You can also specify the environment of which you wish to get the assets.
 """
@@ -27,10 +26,11 @@ def __init__(self, http_instance):
             self.base_url = "{}?{}".format(self.base_url, "environment={}".format(env))
 
     def environment(self, environment):
-        """
-        Provide the name of the environment if you wish to retrieve the assets published
+        r"""Provide the name of the environment if you wish to retrieve the assets published
         in a particular environment.
+
         :param environment: environment of the stack
+
         :return: AssetQuery - so we can chain the call
 
         -----------------------------
@@ -45,12 +45,12 @@ def environment(self, environment):
         return self
 
     def version(self, version):
-        """
-        Specify the version number of the asset that you wish to retrieve.
+        r"""Specify the version number of the asset that you wish to retrieve.
         If the version is not specified, the details of the latest version will be retrieved.
         To retrieve a specific version, keep the environment parameter blank.
 
         :param version: version number of the asset that you wish to retrieve
+
         :return: AssetQuery: so we can chain the call
 
         -----------------------------
@@ -65,9 +65,9 @@ def version(self, version):
         return self
 
     def include_dimension(self):
-        """
-        include the dimensions (height and width) of the image in the response.
+        r"""Include the dimensions (height and width) of the image in the response.
         Supported image types: JPG, GIF, PNG, WebP, BMP, TIFF, SVG, and PSD
+
         :return: AssetQuery: so we can chain the call
 
         -----------------------------
@@ -82,8 +82,8 @@ def include_dimension(self):
         return self
 
     def relative_url(self):
-        """
-        include the relative URLs of the assets in the response.
+        r"""include the relative URLs of the assets in the response.
+
         :return: AssetQuery: so we can chain the call
 
         -----------------------------
@@ -98,11 +98,11 @@ def relative_url(self):
         return self
 
     def find(self):
-        """
-        This call fetches the list of all the assets of a particular stack.
+        r"""This call fetches the list of all the assets of a particular stack.
         It also returns the content of each asset in JSON format.
         Learn more about Assets
         [https://www.contentstack.com/docs/content-managers/work-with-assets].
+
         :return: json result, List of asset object
 
         -----------------------------

contentstack/basequery.py

@@ -50,7 +50,7 @@ def where(self, field_uid: str, query_operation: QueryOperation, fields=None):
         Get entries containing the field values matching the condition in the query.
         Arguments:
             field_uid {str} -- [accept field uid for the operation]
-            query_operation {QueryOperation} -- [Type of operation to perform]
+            query_operation {QueryOperation} -- Type of operation to perform
             fields {list} - list of string
         """
         if None not in (field_uid, query_operation):

contentstack/contenttype.py

@@ -42,8 +42,10 @@ def entry(self, entry_uid: str):
             >>> entry = content_type.entry(uid='entry_uid')
         --------------------------------
         """
-        if None in (self.__content_type_uid, entry_uid):
-            raise KeyError('Please provide valid content_type_uid and entry uid')
+        if self.__content_type_uid is None:
+            raise PermissionError('Please provide valid content_type_uid')
+        elif entry_uid is None:
+            raise PermissionError('Please provide valid entry uid')
         entry = Entry(self.http_instance, self.__content_type_uid, entry_uid=entry_uid)
         return entry
 

examples/__init__.py

@@ -29,7 +29,7 @@
                      "application frontend, and Contentstack will take care of the rest",
     long_description_content_type="text/markdown",
     url="https://github.com/contentstack/contentstack-python",
-    #packages=setuptools.find_packages(),
+    # packages=setuptools.find_packages(),
     packages=['contentstack'],
     license='MIT',
     test_suite='tests.all_tests',