azure-eu and include_metadata support added

Author: ishaileshmishra

README.md

@@ -1,6 +1,4 @@
-#
-
-[![Contentstack](https://www.contentstack.com/docs/static/images/contentstack.png)](https://www.contentstack.com/)
+#[![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) -->
 
@@ -132,7 +130,7 @@ Read through to understand how to use the Sync API with Contentstack Python SDK.
 
 ### The MIT License (MIT)
 
-Copyright © 2012-2021 [Contentstack](https://www.contentstack.com/). All Rights Reserved
+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:
 

contentstack/asset.py

@@ -22,8 +22,7 @@ def __init__(self, http_instance, uid=None):
         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)
+        self.base_url = f'{self.http_instance.endpoint}/assets/{self.__uid}'
         if 'environment' in self.http_instance.headers:
             self.asset_params['environment'] = self.http_instance.headers['environment']
 
@@ -133,5 +132,5 @@ def fetch(self):
             >>> result = asset.fetch()
         ------------------------------
         """
-        url = '{}?{}'.format(self.base_url, parse.urlencode(self.asset_params))
+        url = f'{self.base_url}?{parse.urlencode(self.asset_params)}'
         return self.http_instance.get(url)

contentstack/assetquery.py

@@ -3,7 +3,7 @@
 You can also specify the environment of which you wish to get the assets.
 """
 
-# ************* Module assetquery **************
+# ************* Module asset_query **************
 # Your code has been rated at 10/10 by pylint
 
 import json
@@ -129,6 +129,22 @@ def include_fallback(self):
         self.asset_query_params['include_fallback'] = 'true'
         return self
 
+    def include_metadata(self):
+        """Retrieve the metadata 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().include_metadata().find()
+        ----------------------------
+        """
+        self.asset_query_params['include_metadata'] = 'true'
+        return self
+
     def locale(self, locale: str):
         """Enter locale code. e.g., en-us
         This retrieves published entries of specific locale..

contentstack/basequery.py

@@ -4,7 +4,7 @@
 log = logging.getLogger(__name__)
 
 
-# ************* Module basequery.py **************
+# ************* Module base_query.py **************
 # Your code has been rated at 10.00/10
 
 class QueryOperation(enum.Enum):
@@ -160,7 +160,7 @@ def add_params(self, param: dict):
 
     def query(self, key: str, value):
         """
-        Adds key value pairs to the to the query parameters
+        Adds key value pairs to the query parameters
         Arguments:
             key {str} -- key of the query param
             value {any} -- value of query param

contentstack/contenttype.py

@@ -91,10 +91,9 @@ def fetch(self):
             raise KeyError(
                 'content_type_uid can not be None to fetch contenttype')
         self.local_param['environment'] = self.http_instance.headers['environment']
-        uri = '{}/content_types/{}'.format(
-            self.http_instance.endpoint, self.__content_type_uid)
+        uri = f'{self.http_instance.endpoint}/content_types/{self.__content_type_uid}'
         encoded_params = parse.urlencode(self.local_param)
-        url = '{}?{}'.format(uri, encoded_params)
+        url = f'{uri}?{encoded_params}'
         result = self.http_instance.get(url)
         return result
 
@@ -117,7 +116,9 @@ def find(self, params=None):
         if params is not None:
             self.local_param.update(params)
         encoded_params = parse.urlencode(self.local_param)
-        url = '{}?{}'.format(
-            '{}/content_types'.format(self.http_instance.endpoint), encoded_params)
+        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/entryqueryable.py

@@ -157,6 +157,20 @@ def include_reference_content_type_uid(self):
         self.entry_queryable_param['include_reference_content_type_uid'] = 'true'
         return self
 
+    def include_metadata(self):
+        """
+        This method also includes the metadata in the response
+        [Example for Query]
+            >>> import contentstack
+            >>> stack = contentstack.Stack('api_key', 'delivery_token', 'environment')
+            >>> content_type = stack.content_type('content_type_uid')
+            >>> query = content_type.query()
+            >>> query = query.include_metadata()
+            >>> result = query.find()
+        """
+        self.entry_queryable_param['include_metadata'] = 'true'
+        return self
+
     def add_param(self, key: str, value: str):
         """
         This method adds key and value to an Entry.

contentstack/https_connection.py

@@ -82,9 +82,9 @@ def get(self, url):
                             "message": f'Timeout error ${timeout_err.strerror}'})) from timeout_err
         except ConnectionError as connect_err:
             raise ConnectionError(json.dumps({"httpStatus": 503,
-                                              "message": f'Service error ${connect_err.strerror}'})) from connect_err
+                "message": f'Service error ${connect_err.strerror}'})) from connect_err
         except JSONDecodeError as connection_err:
             raise TypeError(json.dumps({"httpStatus": 503,
-                                        "message": 'Decoding JSON has failed.'})) from connection_err
+                "message": 'Decoding JSON has failed.'})) from connection_err
         except HTTPError as http_err:
             raise HTTPError('Http error occurred') from http_err

contentstack/query.py

@@ -7,8 +7,8 @@
 import logging
 from urllib import parse
 
-import deprecation
 import empty
+from sphinx import deprecation
 
 from contentstack.basequery import BaseQuery
 from contentstack.entryqueryable import EntryQueryable
@@ -267,6 +267,13 @@ def include_embedded_items(self):
         self.query_params['include_embedded_items[]'] = "BASE"
         return self
 
+    def include_metadata(self):
+        """
+        include_metadata includes metadata in the response
+        """
+        self.query_params['include_metadata'] = 'true'
+        return self
+
     def find(self):
         """It fetches the query result.
         List of :class:`Entry <contentstack.entry.Entry>` objects.

contentstack/stack.py

@@ -29,6 +29,7 @@ class ContentstackRegion(enum.Enum):
     US = 'us'
     EU = 'eu'
     AZURE_NA = 'azure-na'
+    AZURE_EU = 'azure-eu'
 
 
 class Stack:
@@ -123,6 +124,8 @@ def _validate_stack(self):
             self.host = 'eu-cdn.contentstack.com'
         elif self.region.value == 'azure-na' and self.host == DEFAULT_HOST:
             self.host = 'azure-na-cdn.contentstack.com'
+        elif self.region.value == 'azure-eu' and self.host == DEFAULT_HOST:
+            self.host = 'azure-eu-cdn.contentstack.com'
         elif self.region.value != 'us':
             self.host = f'{self.region.value}-{DEFAULT_HOST}'
         self.endpoint = f'https://{self.host}/{self.version}'
@@ -329,7 +332,7 @@ def image_transform(self, image_url, **kwargs):
         mobile properties.\n
 
         :param image_url: base url on which queries to apply
-        :param kwargs: append queries to the asset URL.
+        :param kwargs: to append queries to the asset URL.
         :return: instance of ImageTransform
         """
         if image_url is None or image_url == '':
@@ -364,7 +367,6 @@ def _execute_management_api(self):
         _url = f'{_endpoint}/content_types/{_ct_uid}/entries/{_entry_uid}'
         import requests
         r = requests.get(url=_url, verify=True, headers=_headers)
-        # _resp = self.http_instance.get(_url, headers=_headers)
         self.live_preview['resp'] = r.json()['entry']
         return self
 

requirements.txt

@@ -1,21 +1,61 @@
-twython~=3.9.1
-setuptools~=62.1.0
-urllib3~=1.26.2
+twython==3.9.1
+setuptools==67.7.2
+urllib3==2.0.1
 contentstack-utils
 python-dateutil==2.8.2
-requests==2.27.1
-coverage==6.3.2
-tox==3.25.0
-virtualenv==20.14.1
-Sphinx==4.5.0
+requests==2.29.0
+coverage==7.2.5
+tox==4.5.1
+virtualenv==20.23.0
+Sphinx==7.0.0
 sphinxcontrib-websupport==1.2.4
-pip~=22.0.4
-build~=0.7.0
-wheel~=0.37.1
+pip==23.1.2
+build==0.10.0
+wheel==0.40.0
 py~=1.11.0
-lxml~=4.8.0
+lxml==4.9.2
 utils~=1.0.1
-keyring~=23.5.0
-docutils==0.16
+keyring==23.13.1
+docutils==0.19
 pyparsing~=3.0.8
-config~=0.5.1
+config~=0.5.1
+colorama~=0.4.6
+attrs==23.1.0
+argparse~=1.4.0
+toml~=0.10.2
+Jinja2~=3.1.2
+env~=0.1.0
+filelock~=3.12.0
+pluggy~=1.0.0
+six~=1.16.0
+packaging~=23.1
+pytest==7.3.1
+dill~=0.3.6
+pytz==2023.3
+Babel==2.12.1
+pep517==0.13.0
+tomli~=2.0.1
+Werkzeug~=2.3.3
+Flask~=2.3.2
+click~=8.1.3
+MarkupSafe==2.1.2
+blinker~=1.6.2
+itsdangerous~=2.1.2
+isort==5.12.0
+pkginfo==1.9.6
+pylint==2.17.3
+astroid==2.15.4
+mccabe==0.7.0
+platformdirs~=3.5.0
+imagesize==1.4.1
+snowballstemmer~=2.2.0
+Pygments~=2.15.1
+wrapt==1.15.0
+certifi==2022.12.7
+oauthlib==3.2.2
+idna==3.4
+chardet~=5.1.0
+alabaster==0.7.13
+zipp==3.15.0
+distlib~=0.3.6
+Empty~=0.4.4