Improved code quality using pylint, added docstrings wherever required

Author: ppatidar2021

setup.py

@@ -1,3 +1,6 @@
+"""
+Setup file
+"""
 import setuptools
 setuptools.setup(
     name="bitpay",

setup/bitpay_setup.py

@@ -36,8 +36,8 @@ def select_env():
 
         set_environment(environment)
         select_create_key()
-    except BitPayException as e:
-        print(e)
+    except BitPayException as exe:
+        print(exe)
 
 
 def set_environment(env):
@@ -55,16 +55,16 @@ def select_create_key():
             create_new_key()
         else:
             load_key()
-    except BitPayException as e:
-        print(e)
+    except BitPayException as exe:
+        print(exe)
 
 
 def create_new_key():
     try:
         private_key = generate_pem()
         store_key(private_key)
-    except BitPayException as e:
-        print(e)
+    except BitPayException as exe:
+        print(exe)
 
 
 def store_key(private_key):
@@ -86,8 +86,8 @@ def store_key(private_key):
             select_tokens(private_key)
         else:
             store_key(private_key)
-    except BitPayException as e:
-        print(e)
+    except BitPayException as exe:
+        print(exe)
 
 
 def select_tokens(private_key):
@@ -99,8 +99,8 @@ def select_tokens(private_key):
             request_tokens(input_value.lower(), private_key)
         else:
             select_tokens(private_key)
-    except BitPayException as e:
-        print(e)
+    except BitPayException as exe:
+        print(exe)
 
 
 def request_tokens(token_type, private_key):
@@ -135,8 +135,8 @@ def request_tokens(token_type, private_key):
                 print("Payout Token Pairing Code: ", response.json()['data'][0]['pairingCode'] + "\n")
 
         update_config_file()
-    except BitPayException as e:
-        print(e)
+    except BitPayException as exe:
+        print(exe)
 
 
 def update_config_file():
@@ -167,8 +167,8 @@ def update_config_file():
         print(f"{api_url}/dashboard/merchant/api-tokens\r\n")
         print("\r\nOnce you have this Pairing Code/s approved you can move the generated files to a secure location "
               "and start using the Client.\r\n")
-    except BitPayException as e:
-        print(e)
+    except BitPayException as exe:
+        print(exe)
 
 
 def load_key():

src/bitpay_sdk/client.py

@@ -1,18 +1,43 @@
+"""
+class Config
+"""
+
+
 class Config:
+    """
+    class Config that set and get configurations
+    """
+
     __environment = ""
     __envconfig = ""
 
     def __init__(self):
         pass
 
     def get_environment(self):
+        """
+        Get method for to environment
+        :return: environment
+        """
         return self.__environment
 
     def set_environment(self, environment):
+        """
+        Set method for to environment
+        :param environment: environment
+        """
         self.__environment = environment
 
     def get_envconfig(self):
+        """
+        Get method for to envconfig
+        :return: envconfig
+        """
         return self.__envconfig
 
     def set_envconfig(self, envconfig):
+        """
+        Set method for to envconfig
+        :param envconfig: envconfig
+        """
         self.__envconfig = envconfig

src/bitpay_sdk/config.py

@@ -1,8 +1,8 @@
-Test="Test"
-Prod="Prod"
-TestUrl="https://test.bitpay.com/"
-ProdUrl="https://bitpay.com/"
-BitpayApiVersion="2.0.0"
-BitpayPluginInfo="BitPay_Python_Client_v6.0.2111"
-BitpayApiFrame="std"
-BitpayApiFrameVersion="1.0.0"
+TEST = "Test"
+PROD = "Prod"
+TESTURL = "https://test.bitpay.com/"
+PRODURL = "https://bitpay.com/"
+BITPAYAPIVERSION = "2.0.0"
+BITPAYPLUGININFO = "BitPay_Python_Client_v6.0.2111"
+BITPAYAPIFRAME = "std"
+BITPAYAPIFRAMEVERSION = "1.0.0"

src/bitpay_sdk/env.py

@@ -1,15 +1,28 @@
+"""
+Bill Creation Exception gets raised when request for bill creation gets failed.
+"""
 from .bill_exception import BillException
 
 
 class BillCreationException(BillException):
+    """
+    BillCreationException
+    """
     __bitpay_message = "Failed to create bill"
     __bitpay_code = "BITPAY-BILL-CREATE"
     __api_code = ""
 
     def __init__(self, message, code=112, api_code="000000"):
+        """
+        Construct the BillCreationException.
+
+        :param message: The Exception message to throw.
+        :param code: [optional] The Exception code to throw.
+        :param api_code: [optional] The API Exception code to throw.
+        """
         message = self.__bitpay_code + ": " + self.__bitpay_message + ":" + message
         self.__api_code = api_code
-        super(BillCreationException, self).__init__(message, code)
+        super().__init__(message, code)
 
     # def get_api_code(self):
     #     return self.__api_code

src/bitpay_sdk/exceptions/bill_creation_exception.py

@@ -1,15 +1,28 @@
+"""
+Bill Delivery Exception gets raised when request for bill delivery gets failed.
+"""
 from .bill_exception import BillException
 
 
 class BillDeliveryException(BillException):
+    """
+    BillDeliveryException
+    """
     __bitpay_message = "Failed to deliver bill"
     __bitpay_code = "BITPAY-BILL-DELIVERY"
     __api_code = ""
 
     def __init__(self, message, code=115, api_code="000000"):
+        """
+        Construct the BillDeliveryException.
+
+        :param message: The Exception message to throw.
+        :param code: [optional] The Exception code to throw.
+        :param api_code: [optional] The API Exception code to throw.
+        """
         message = self.__bitpay_code + ": " + self.__bitpay_message + ":" + message
         self.__api_code = api_code
-        super(BillDeliveryException, self).__init__(message, code)
+        super().__init__(message, code)
 
     # def get_api_code(self):
     #     return self.__api_code

src/bitpay_sdk/exceptions/bill_delivery_exception.py

@@ -1,15 +1,29 @@
+"""
+Bill Exception gets raised when some unexpected error occurs while processing a request
+or trying to manage bills.
+"""
 from .bitpay_exception import BitPayException
 
 
 class BillException(BitPayException):
+    """
+    BillException
+    """
     __bitpay_message = "An unexpected error occurred while trying to manage the bill"
     __bitpay_code = "BITPAY-BILL-GENERIC"
     __api_code = ""
 
     def __init__(self, message="", code=111, api_code="000000"):
+        """
+        Construct the BillException.
+
+        :param message: The Exception message to throw.
+        :param code: [optional] The Exception code to throw.
+        :param api_code: [optional] The API Exception code to throw.
+        """
         message = self.__bitpay_code + ": " + self.__bitpay_message + ":" + message
         self.__api_code = api_code
-        super(BillException, self).__init__(message, code)
+        super().__init__(message, code)
 
     # def get_api_code(self):
     #     return self.__api_code

src/bitpay_sdk/exceptions/bill_exception.py

@@ -1,15 +1,28 @@
+"""
+Bill Query Exception gets raised when request for bill retrieval gets failed .
+"""
 from .bill_exception import BillException
 
 
 class BillQueryException(BillException):
+    """
+    BillQueryException
+    """
     __bitpay_message = "Failed to retrieve bill"
     __bitpay_code = "BITPAY-REFUND-GET"
     __api_code = ""
 
     def __init__(self, message, code=113, api_code="000000"):
+        """
+        Construct the BillQueryException.
+
+        :param message: The Exception message to throw.
+        :param code: [optional] The Exception code to throw.
+        :param api_code: [optional] The API Exception code to throw.
+        """
         message = self.__bitpay_code + ": " + self.__bitpay_message + ":" + message
         self.__api_code = api_code
-        super(BillQueryException, self).__init__(message, code)
+        super().__init__(message, code)
 
     # def get_api_code(self):
     #     return self.__api_code

src/bitpay_sdk/exceptions/bill_query_exception.py

@@ -1,15 +1,28 @@
+"""
+Bill Update Exception gets raised when it fails to update bill
+"""
 from .bill_exception import BillException
 
 
 class BillUpdateException(BillException):
+    """
+    BillUpdateException
+    """
     __bitpay_message = "Failed to update bill"
     __bitpay_code = "BITPAY-BILL-UPDATE"
     __api_code = ""
 
     def __init__(self, message, code=114, api_code="000000"):
+        """
+        Construct the BillUpdateException.
+
+        :param message: The Exception message to throw.
+        :param code: [optional] The Exception code to throw.
+        :param api_code: [optional] The API Exception code to throw.
+        """
         message = self.__bitpay_code + ": " + self.__bitpay_message + ":" + message
         self.__api_code = api_code
-        super(BillUpdateException, self).__init__(message, code)
+        super().__init__(message, code)
 
     # def get_api_code(self):
     #     return self.__api_code