v1.1.0 pylint applied.

score: 9.96/10

Author: mshaileshr@gmail.com

CHANGELOGS.md

@@ -1,6 +1,17 @@
 CHANGELOG
 =============
 
+
+
+*Date: 7-Aug-2020 - initial release*
+
+**v1.1.0**
+============
+- **EntryQueryable**
+    - updated include_reference function.
+
+-----------------------------
+
 *Date: 17-Jun-2020 - initial release*
 
 **v1.0.0**

changelog.rst

@@ -6,7 +6,7 @@ CHANGELOG
 
 **v1.1.0**
 ============
-- **EntryQueyable**
+- **EntryQueryable**
     - updated include_reference function.
 
 -----------------------------

contentstack/__init__.py

@@ -1,3 +1,12 @@
+"""
+The __init__.py files are required to make Python treat the directories as containing
+packages; this is done to prevent directories with a common name, such as string,
+from unintentionally hiding valid modules that occur later on the module search path
+
+file __init__.py contains package information like
+__author__, __status__, __version__, __endpoint__ and __email__
+
+"""
 from .entry import Entry
 from .asset import Asset
 from .contenttype import ContentType
@@ -10,4 +19,4 @@
 __status__ = 'debug'
 __version__ = '1.1.0'
 __endpoint__ = 'cdn.contentstack.io'
-__email__ = 'mshaileshr@gmail.com'
+__email__ = 'shailesh.mishra@contentstack.com'

contentstack/contenttype.py

@@ -9,6 +9,7 @@
 # Your code has been rated at 10.00/10 by pylint
 
 from urllib import parse
+
 from contentstack.entry import Entry
 from contentstack.query import Query
 
@@ -44,7 +45,7 @@ def entry(self, entry_uid: str):
         """
         if self.__content_type_uid is None:
             raise PermissionError('Please provide valid content_type_uid')
-        elif entry_uid is None:
+        if 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

contentstack/entryqueryable.py

@@ -1,3 +1,7 @@
+"""
+EntryQueryable class contains common functions
+that is used as parents class for the query and entry classes
+"""
 
 
 class EntryQueryable:
@@ -80,10 +84,17 @@ def include_reference(self, field_uid):
 
         Arguments:
         Array of the only reference keys to be included in response
-        field_uid {str or list of str} -- [str/list of str] of field_uid on which include operation to perform
+        field_uid {str or list of str} -- [str/list of str] of field_uid on
+        which include operation to perform
 
         Returns:
             self -- So you can chain this call.
+
+            >>> import contentstack
+            >>> stack = contentstack.Stack('api_key', 'delivery_token', 'environment')
+            >>> entry = stack.content_type('content_type')
+            >>> entry("entry_uid").include_reference(["categories", "brand"])
+            >>> result = entry.fetch()
         """
         if field_uid is not None and isinstance(field_uid, (str, list)):
             self.entry_queryable_param["include[]"] = field_uid

contentstack/https_connection.py

@@ -1,20 +1,16 @@
 """
-# -*- coding: utf-8 -*-
-requests.api
-~~~~~~~~~~~~
-
 This module implements the Requests API.
 """
 
 # ************* Module https_connection.py **************
 # Your code has been rated at 10.00/10  by pylint
 
-from json import JSONDecodeError
-import json
-import urllib.parse as urlparse
 import platform
+from json import JSONDecodeError
+
 import requests
 from requests.exceptions import Timeout, HTTPError
+
 import contentstack
 
 
@@ -77,9 +73,14 @@ def update_connection_timeout(self, timeout: int):
         """Facilitate to update timeout for the https request"""
         self.default_timeout = timeout
 
-    def get_complete_url(self, base_url: str, params: dict):
-        if 'query' in params:
-            params["query"] = json.dumps(params["query"])
-        query = urlparse.urlencode(params)
-        url = '{}&{}'.format(base_url, query)
-        return url
+    # def get_complete_url(self, base_url: str, params: dict):
+    #     """
+    #     creates complete url with the help of base_url and query parameters
+    #     :param base_url: base url
+    #     :param params: query parameters
+    #     :return: url
+    #     """
+    #     if 'query' in params:
+    #         params["query"] = json.dumps(params["query"])
+    #     query = urlparse.urlencode(params)
+    #     return '{}&{}'.format(base_url, query)

contentstack/image_transform.py

@@ -6,18 +6,20 @@
 different transform_params in second parameter in array form
 """
 
+
 # ************* Module image_transform **************
 # Your code has been rated at 10.00/10  by pylint
 
 
-class ImageTransform:
+class ImageTransform:  # pylint: disable=too-few-public-methods
     """
     The Image Delivery API is used to retrieve, manipulate and/or convert image
     files
     """
 
     def __init__(self, http_instance, image_url, **kwargs):
         """
+        creates instance of the ImageTransform class
         :param httpInstance: instance of HttpsConnection
         :param image_url: url on which manipulation required, Image transformation url
         :param kwargs: parameter in which we want to place different
@@ -50,5 +52,3 @@ def get_url(self):
         if args:
             self.image_url += '?{0}'.format('&'.join(args))
         return self.image_url
-
-

contentstack/utility.py

@@ -1,21 +1,25 @@
 """
 Utils
 contentstack
-Created by Shailesh Mishra on 22/06/19.
+Last modified by Shailesh Mishra on 06/08/20.
 Copyright 2019 Contentstack. All rights reserved.
 """
 
-# ************* Module utility **************
-# Your code has been rated at 10.00/10
+# ************* Module utility checked using pylint **************
+# Your code has been rated at 10.00/10 (previous run: 10.00/10, +0.00)
 
 
-import logging
 import json
-import urllib.parse as urlparse
+import logging
+from urllib import parse
 
 
 def config_logging(logging_type: logging.WARNING):
-    import logging
+    """
+    This is to create logging config
+    :param logging_type:  Level of the logging
+    :return: basicConfig instance
+    """
     logging.basicConfig(
         filename='application.log',
         level=logging_type,
@@ -50,13 +54,22 @@ def log(message):
 
     @staticmethod
     def do_url_encode(params):
-        from urllib import parse
+        """
+        To encode url with query parameters
+        :param params:
+        :return: encoded url
+        """
         return parse.urlencode(params)
 
     @staticmethod
     def get_complete_url(base_url: str, params: dict):
+        """
+        creates complete url using base_url and their respective parameters
+        :param base_url:
+        :param params:
+        :return:
+        """
         if 'query' in params:
             params["query"] = json.dumps(params["query"])
-        query = urlparse.urlencode(params)
-        url = '{}&{}'.format(base_url, query)
-        return url
+        query = parse.urlencode(params)
+        return '{}&{}'.format(base_url, query)

package.json

@@ -1,6 +1,4 @@
 {
   "name": "contentstack.python",
-  "version": "1.0.0",
-  "dependencies": {
-  }
+  "version": "1.1.0"
 }

setup.py

@@ -17,27 +17,26 @@
     name="contentstack",
     keywords='contentstack-python',
     version="1.1.0",
-    author="contentstack",
-    author_email="mshaileshr@gmail.com",
+    author="Contentstack",
+    author_email="shailesh.mishra@contentstack.com",
     description="Contentstack is a headless CMS with an API-first approach.",
     long_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",
     long_description_content_type="text/markdown",
     url="https://github.com/contentstack/contentstack-python",
-    # packages=setuptools.find_packages(),
     packages=['contentstack'],
     license='MIT',
     test_suite='tests.all_tests',
     install_requires=['requests>=1.1.0'],
     classifiers=[
-            "License :: OSI Approved :: MIT License",
-            "Operating System :: OS Independent",
-            'Intended Audience :: Developers',
-            'Natural Language :: English',
-            'Programming Language :: Python :: 3.6',
-            'Programming Language :: Python :: 3.7',
-        ],
+        "License :: OSI Approved :: MIT License",
+        "Operating System :: OS Independent",
+        'Intended Audience :: Developers',
+        'Natural Language :: English',
+        'Programming Language :: Python :: 3.6',
+        'Programming Language :: Python :: 3.7',
+    ],
     python_requires='>=3.6',
     zip_safe=False,
-)
+)