Contentstack 0.1.0__tar.gz → 1.0.0__tar.gz

contentstack-1.0.0/PKG-INFO

@@ -0,0 +1,19 @@
+Metadata-Version: 2.1
+Name: contentstack
+Version: 1.0.0
+Summary: Contentstack is a headless CMS with an API-first approach.
+Home-page: https://github.com/contentstack/contentstack-python
+Author: contentstack
+Author-email: mshaileshr@gmail.com
+License: MIT
+Description: 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
+Keywords: contentstack-python
+Platform: UNKNOWN
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Operating System :: OS Independent
+Classifier: Intended Audience :: Developers
+Classifier: Natural Language :: English
+Classifier: Programming Language :: Python :: 3.6
+Classifier: Programming Language :: Python :: 3.7
+Requires-Python: >=3.6
+Description-Content-Type: text/markdown

{contentstack-0.1.0 → contentstack-1.0.0}/README.md

@@ -1,12 +1,13 @@
 [![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=1.0.0)  ![Coverage](https://raw.githubusercontent.com/contentstack/contentstack-python/c13bfddf10391924ed2323fdacf1e8914c7c857c/coverage.svg) ![pip](https://img.shields.io/badge/pip-1.0.0-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).
@@ -15,67 +16,60 @@ You will need python 3 installed on your machine. You can install it from [here]
 
 To use the Contentstack Python SDK to your existing project, perform the steps given below:
 
-**Install contentstack pip**
+### Install contentstack pip
 
-```
-pip install contentstack
-```
+	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/guide/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/guide/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/guide/content-management#working-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/guide/content-management#working-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/guide/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 (config is optional):
-```
-stack = contentstack.Stack(api_key='api_key', access_token='access_token', environment='environment', config=config)
-```
-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 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:
 
+    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.
 
 #### Querying content from your stack
 
 To retrieve a single entry from a content type use the code snippet given below:
 
-```
-content_type = stack.content_type("content_type_uid")
-entry = content_type.entry("entry_uid")
-result = entry.fetch()
-```
+	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:
 
-```
-//stack is an instance of Stack class
-query = stack.content_type("content_type_uid").query()
-result = query.find()
-```
+	stack = contentstack.Stack('api_key','delivery_token','environment')
+	query = stack.content_type("content_type_uid").query()
+	result = query.find()
 
 
 ### Advanced Queries
@@ -90,32 +84,27 @@ We have introduced Image Delivery APIs that let you retrieve images and then man
 
 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/blteae40eb499811073/bltc5064f36b5855343/59e0c41ac0eddd140d5a8e3e/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/apis/image-delivery-api/).
+[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.
 
-```
-//set the image quality to 100
-image_params = {'quality': 100}
-imageUrl = stack.image_transform(image_url, **image_params);
+	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()
 
-//resize the image by specifying width and height
-image_params = {'width': 100, 'height': 100}
-imageUrl = stack.image_transform(imageUrl, **image_params);
+### Using the Sync API with Python SDK
 
-//enable auto optimization for the image
-image_params = {'auto': 'webp'}
-imageUrl = stack.image_transform(imageUrl, **imageParams);
-```
+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://contentstack.com/docs)
-- [Content Delivery API Docs](https://contentstack.com/docs/apis/content-delivery-api/)
-
+- [Content Delivery API Docs](https://www.contentstack.com/docs/developers/apis/content-delivery-api/)
 
 ### The MIT License (MIT)
 
@@ -125,4 +114,4 @@ Permission is hereby granted, free of charge, to any person obtaining a copy of
 
 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.

contentstack-1.0.0/contentstack/__init__.py

@@ -0,0 +1,13 @@
+from .entry import Entry
+from .asset import Asset
+from .contenttype import ContentType
+from .https_connection import HTTPSConnection
+from .stack import Stack
+from .utility import Utils
+# from contentstack import *
+
+__author__ = 'Contentstack'
+__status__ = 'debug'
+__version__ = '1.0.0'
+__endpoint__ = 'cdn.contentstack.io'
+__email__ = 'mshaileshr@gmail.com'

contentstack-1.0.0/contentstack/asset.py

@@ -0,0 +1,140 @@
+r"""Assets refer to all the media files (images, videos, PDFs, audio files,
+and so on) uploaded in your Contentstack repository for future use.
+
+These files can be attached and used in multiple entries.
+"""
+
+# ************* Module asset **************
+# Your code has been rated at 10/10 by pylint
+
+from urllib import parse
+
+
+class Asset:
+    r"""Asset refer to all the media files (images, videos, PDFs, audio files, and so on)."""
+
+    def __init__(self, http_instance, uid=None):
+        self.http_instance = http_instance
+        self.__query_params = {}
+        self.__uid = uid
+        if self.__uid is None or self.__uid.strip() == 0:
+            raise KeyError('Please provide valid uid')
+        self.base_url = '{}/assets/{}'.format(self.http_instance.endpoint, self.__uid)
+        if 'environment' in self.http_instance.headers:
+            self.__query_params['environment'] = self.http_instance.headers['environment']
+            # self.http_instance.headers.pop('environment')
+
+    def environment(self, environment):
+        r"""Provide the name of the environment if you wish to retrieve the assets published
+        in a particular environment.
+
+        :param environment {str} - name of the environment
+
+        :return: Asset, so we can chain the call
+
+        -------------------------------
+        [Example]:
+
+            >>> import contentstack
+            >>> stack = contentstack.Stack('api_key', 'delivery_token', 'environment')
+            >>> asset = stack.asset(uid='asset_uid')
+            >>> asset = asset.environment('production')
+        -------------------------------
+        """
+        if environment is not None or environment is str:
+            self.__query_params['environment'] = environment
+        return self
+
+    def remove_environment(self):
+        r"""Removes environment from the request params
+
+        :return: Asset, so we can chain the call
+
+        -------------------------------
+        [Example]:
+
+            >>> import contentstack
+            >>> stack = contentstack.Stack('api_key', 'delivery_token', 'environment')
+            >>> asset = stack.asset(uid='asset_uid')
+            >>> asset = asset.remove_header()
+            >>> asset.fetch()
+        -------------------------------
+        """
+        if 'environment' in self.http_instance.headers:
+            self.http_instance.headers.pop('environment')
+        return self
+
+    def params(self, key, value):
+        r"""params is used to pass additional parameters to the asset query
+
+        :param key: key of the query parameter
+
+        :param value: value of the query parameter
+
+        :return: Asset, so we can chain the call
+
+        -----------------------------
+        Example::
+
+            >>> import contentstack
+            >>> stack = contentstack.Stack('api_key', 'delivery_token', 'environment')
+            >>> asset = stack.asset(uid='asset_uid')
+            >>> asset = asset.params('key', 'value')
+        -----------------------------
+        """
+        if None in (key, value) or not isinstance(key, str):
+            raise KeyError('Kindly provide valid params')
+        self.__query_params[key] = value
+        return self
+
+    def relative_urls(self):
+        r"""Include the relative URLs of the assets in the response.
+
+        :return: Asset, so we can chain the call
+
+        ----------------------------
+        Example::
+
+            >>> import contentstack
+            >>> stack = contentstack.Stack('api_key', 'delivery_token', 'environment')
+            >>> asset = stack.asset(uid='asset_uid')
+            >>> asset = asset.relative_urls()
+        ----------------------------
+        """
+        self.__query_params['relative_urls'] = 'true'
+        return self
+
+    def include_dimension(self):
+        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: Asset, so we can chain the call
+
+        ----------------------------
+        Example::
+
+            >>> import contentstack
+            >>> stack = contentstack.Stack('api_key', 'delivery_token', 'environment')
+            >>> asset = stack.asset(uid='asset_uid')
+            >>> asset = asset.include_dimension()
+        ----------------------------
+        """
+        self.__query_params['include_dimension'] = "true"
+        return self
+
+    def fetch(self):
+        r"""This call fetches the latest version of a specific asset of a particular stack.
+
+        :return: json response of asset
+
+        -----------------------------
+        [Example]:
+
+            >>> import contentstack
+            >>> stack = contentstack.Stack('api_key', 'delivery_token', 'environment')
+            >>> asset = stack.asset(uid='asset_uid')
+            >>> result = asset.fetch()
+        ------------------------------
+        """
+        url = '{}?{}'.format(self.base_url, parse.urlencode(self.__query_params))
+        return self.http_instance.get(url)

contentstack-1.0.0/contentstack/assetquery.py

@@ -0,0 +1,119 @@
+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.
+"""
+
+# ************* Module assetquery **************
+# Your code has been rated at 10/10 by pylint
+
+import json
+from contentstack.utility import Utils
+from contentstack.basequery import BaseQuery
+
+
+class AssetQuery(BaseQuery):
+    """
+    This call fetches the list of all the assets of a particular stack.
+    """
+
+    def __init__(self, http_instance):
+        super().__init__()
+        self.http_instance = http_instance
+        self.__query_params = {}
+        self.base_url = "{}/assets".format(self.http_instance.endpoint)
+        if "environment" in self.http_instance.headers:
+            env = self.http_instance.headers["environment"]
+            self.base_url = "{}?{}".format(self.base_url, "environment={}".format(env))
+
+    def environment(self, environment):
+        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
+
+        -----------------------------
+        [Example]:
+
+            >>> import contentstack
+            >>> stack = contentstack.Stack('api_key', 'delivery_token', 'environment')
+            >>> result = stack.asset_query().environment('production').find()
+        ------------------------------
+        """
+        self.__query_params["environment"] = environment
+        return self
+
+    def version(self, version):
+        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
+
+        -----------------------------
+        [Example]:
+
+            >>> import contentstack
+            >>> stack = contentstack.Stack('api_key', 'delivery_token', 'environment')
+            >>> result = stack.asset_query().version(3).find()
+        ------------------------------
+        """
+        self.__query_params["version"] = version
+        return self
+
+    def include_dimension(self):
+        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
+
+        -----------------------------
+        [Example]:
+
+            >>> import contentstack
+            >>> stack = contentstack.Stack('api_key', 'delivery_token', 'environment')
+            >>> result = stack.asset_query().include_dimension().find()
+        ------------------------------
+        """
+        self.__query_params["include_dimension"] = "true"
+        return self
+
+    def relative_url(self):
+        r"""include the relative URLs of the assets in the response.
+
+        :return: AssetQuery: so we can chain the call
+
+        -----------------------------
+        [Example]:
+
+            >>> import contentstack
+            >>> stack = contentstack.Stack('api_key', 'delivery_token', 'environment')
+            >>> result = stack.asset_query().relative_url().find()
+        ------------------------------
+        """
+        self.__query_params["relative_urls"] = "true"
+        return self
+
+    def find(self):
+        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
+
+        -----------------------------
+        [Example]:
+
+            >>> import contentstack
+            >>> stack = contentstack.Stack('api_key', 'delivery_token', 'environment')
+            >>> result = stack.asset_query().find()
+
+        """
+        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)
+        return self.http_instance.get(url)

contentstack-1.0.0/contentstack/basequery.py

@@ -0,0 +1,197 @@
+"""
+Missing docstring
+Common Query for Entry and Assets
+"""
+import enum
+
+
+# ************* Module basequery.py **************
+# Your code has been rated at 10.00/10
+
+class QueryOperation(enum.Enum):
+    """
+    QueryOperation is enum that Provides Options to perform operation to query the result.
+
+    Available Options for QueryOperation are below.
+    EQUALS, NOT_EQUALS, INCLUDES, EXCLUDES, IS_LESS_THAN, IS_LESS_THAN_OR_EQUAL
+    IS_GREATER_THAN, IS_GREATER_THAN_OR_EQUAL, EXISTS, MATCHES
+
+    Arguments:
+        enum {QueryOperation} -- Type of operation to perform
+    """
+    EQUALS = ""
+    NOT_EQUALS = '$ne'
+    INCLUDES = '$in'
+    EXCLUDES = '$nin'
+    IS_LESS_THAN = '$lt'
+    IS_LESS_THAN_OR_EQUAL = '$lte'
+    IS_GREATER_THAN = '$gt'
+    IS_GREATER_THAN_OR_EQUAL = '$gte'
+    EXISTS = '$exists'
+    MATCHES = '$regex'
+
+
+def _get_operation_value(fields):
+    value = fields[0] if isinstance(fields, list) and len(fields) == 1 else fields
+    return value
+
+
+class BaseQuery:
+    """
+    Common Query class works for Query As well as Asset
+    """
+
+    def __init__(self):
+        self.parameters = {}
+        self.query_params = {}
+
+    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
+            fields {list} - list of string
+        """
+        if None not in (field_uid, query_operation):
+            result = _get_operation_value(fields) if query_operation.name == "EQUALS" \
+                else {query_operation.value: fields}
+            self.parameters[field_uid] = result
+        return self
+
+    def include_count(self):
+        """Retrieve count and data of objects in result
+        Returns:
+            [Query] -- Query object, so you can chain this call.
+        ==============================
+        [Example:]
+            >>> import contentstack
+            >>> stack = contentstack.Stack('api_key', 'access_token', 'environment')
+            >>> content_type = stack.content_type('content_type_uid')
+            >>> query = content_type.query()
+            >>> query = query.include_count()
+            >>> result = query.find()
+        ==============================
+        """
+        self.query_params["include_count"] = 'true'
+        return self
+
+    def skip(self, skip_count: int):
+        """
+        The number of objects to skip before returning any.
+        skip_count No of objects to skip from returned objects
+        :param skip_count:
+        :return: self
+        """
+        self.query_params["skip"] = str(skip_count)
+        return self
+
+    def limit(self, limit_count: int):
+        """
+        A limit on the number of objects to return.
+        :param limit_count:
+        :return: self
+        """
+        self.query_params["skip"] = str(limit_count)
+        return self
+
+    def order_by_ascending(self, key: str):
+        """
+        you can sort them in the ascending order with respect to the
+        value of a specific field in the response body.
+
+        :param key:  key on which ascending order to be implemented
+        :return: self
+        """
+        self.query_params["asc"] = str(key)
+        return self
+
+    def order_by_descending(self, key: str):
+        """
+        you can sort them in the descending order with respect to the value
+        of a specific field in the response body.
+        :param key:  key on which descending order to be implemented
+        :return: self - Class instance, So that method chaining can be performed
+        """
+        self.query_params["desc"] = str(key)
+        return self
+
+    def param(self, key: str, value):
+        """
+        Adds Parameters to the to the request
+
+        Arguments:
+            key {str} -- Key of the parameter
+            value {[any]} -- Value of the parameter
+
+        Raises:
+            KeyError: When None found in key or value
+
+        Returns:
+            [self] -- instance of the class
+
+        -----------------------------------
+
+        [Example]
+            >>> import contentstack
+            >>> stack = contentstack.Stack('api_key', 'access_token', 'environment')
+            >>> content_type = stack.content_type('content_type_uid')
+            >>> query = content_type.query()
+            >>> query = query.param("key", "value")
+            >>> result = query.find()
+
+        -----------------------------------
+        """
+        if None in (key, value):
+            raise KeyError('Invalid key or value')
+        self.query_params[key] = str(value)
+        return self
+
+    def add_params(self, param: dict):
+        """
+        Adds Parameters to the to the request
+        Arguments:
+            param {dict} --  parameters
+        Returns:
+            [self] -- Class instance, So that method chaining can be performed
+        """
+        self.query_params.update(param)
+        return self
+
+    def query(self, key: str, value):
+        """
+        Adds key value pairs to the to the query parameters
+        Arguments:
+            key {str} -- key of the query param
+            value {any} -- value of query param
+        Raises:
+            KeyError: when key or value found None
+        Returns:
+            self-- Class instance, So that method chaining can be performed
+        """
+        if None in (key, value):
+            raise KeyError('Invalid key or value')
+        self.parameters[key] = str(value)
+        return self
+
+    def remove_param(self, key: str):
+        """
+        Remove provided query key from custom query if exist.
+        :param key {str} -- The key to be constrained
+        :return: self -- So that method chaining can be performed
+
+        ----------------------------------
+        [Example]:
+            >>> import contentstack
+            >>> stack = contentstack.Stack('api_key', 'delivery_token', 'environment')
+            >>> content_type = stack.content_type('content_type_uid')
+            >>> query = content_type.query()
+            >>> query = query.remove_query("query_key")
+            >>> result = query.find()
+        ----------------------------------
+        """
+        if key is None:
+            raise ValueError('Kindly provide valid key')
+        if key in self.query_params:
+            self.query_params.pop(key, None)
+        return self