- General code improvements

- Corrected few testcases
- Single place for credentials
- linting added

Author: ishaileshmishra

apidoc/Test Results - .html

@@ -1,6 +1,5 @@
 """The __init__.py file that contains modules that need to import"""
 
-
 from contentstack_management import contentstack
 
 __title__ = 'contentstack-cms'

contentstack_management/__init__.py

@@ -3,7 +3,6 @@
 import contentstack_management
 from .core.client import ApiClient
 
-
 default_host = 'api.contentstack.io'
 default_endpoint = 'https://api.contentstack.io'
 default_api_version = 'v3'
@@ -31,7 +30,7 @@ def user_agents(headers):
     ), 'os': str(__platform())})
 
     package = f"contentstack-management-python/{contentstack_management.__version__}"
-    return {'User-Agent': str(headers), "X-User-Agent": package, 'Content-Type': 'application/json' }
+    return {'User-Agent': str(headers), "X-User-Agent": package, 'Content-Type': 'application/json'}
 
 
 def client(endpoint=None,
@@ -76,4 +75,3 @@ def client(endpoint=None,
                      headers=headers, authorization=authorization,
                      timeout=timeout, failure_retry=failure_retry, exceptions=exceptions, errors=errors,
                      max_requests=max_requests, retry_on_error=retry_on_error)
-

contentstack_management/contentstack.py

@@ -3,12 +3,15 @@
 The create(), read(), update(), and delete() methods each correspond to 
 the CRUD operations that can be performed on the API """
 
-import requests
 import json
+
+import requests
+
 from ..organizations.organizations import Organization
-from ..users.user import User
 from ..stack.stack import Stack
 from ..user_session.user_session import UserSession
+from ..users.user import User
+
 
 class ApiClient:
     """
@@ -32,7 +35,6 @@ def __init__(self, endpoint, host, headers, authtoken, authorization, failure_re
         self.max_requests = max_requests
         self.retry_on_error = retry_on_error
 
-
     def get(self, url, headers=None, params=None):
         """
         Perform an HTTP GET request with the specified URL and parameters.
@@ -65,7 +67,7 @@ def post(self, url, headers=None, params=None, data=None, json_data=None):
         :param headers: Optional dictionary of headers to include in the request.
         :param params: Optional dictionary of URL parameters to include in the request.
         :param data: Optional dictionary, list of tuples, or bytes to include in the body of the request.
-        :param json: Optional JSON data to include in the body of the request.
+        :param json_data: Optional JSON data to include in the body of the request.
         :return: The response from the server.
         """
         return self._call_request('POST', url, headers=headers, params=params, data=data, json_data=json_data)
@@ -80,9 +82,7 @@ def delete(self, url, headers=None, params=None):
         :return: The response from the server.
         """
         return self._call_request('DELETE', url, headers=headers, params=params)
-    
 
-    
     def _call_request(self, method, url_path, headers=None, params=None, data=None, json_data=None):
         url = f"{self.endpoint}/{url_path}"
         retries = self.failure_retry + 1
@@ -108,7 +108,7 @@ def _call_request(self, method, url_path, headers=None, params=None, data=None,
                 else:
                     return None
 
-    def login(self,  email=None, password=None):
+    def login(self, email=None, password=None):
         """
         Fetches the user details and logging into the stack
         :return: User details, fetch authtoken.
@@ -122,17 +122,15 @@ def login(self,  email=None, password=None):
         """
 
         self.api_client = ApiClient(
-                    host=self.host, endpoint=self.endpoint, authtoken=self.authtoken,
-                     headers=self.headers, authorization=self.authorization,
-                     timeout=self.timeout, failure_retry=self.failure_retry, exceptions=self.exceptions, errors=self.errors,
-                     max_requests=self.max_requests, retry_on_error=self.retry_on_error
+            host=self.host, endpoint=self.endpoint, authtoken=self.authtoken,
+            headers=self.headers, authorization=self.authorization,
+            timeout=self.timeout, failure_retry=self.failure_retry, exceptions=self.exceptions, errors=self.errors,
+            max_requests=self.max_requests, retry_on_error=self.retry_on_error
         )
-        response = UserSession(username=email, password= password, api_client=self.api_client).login()
-        self.auth_token = self.get_authtoken(response.json())  if response.status_code == 200 else self.authtoken 
+        response = UserSession(username=email, password=password, api_client=self.api_client).login()
+        self.auth_token = self.get_authtoken(response.json()) if response.status_code == 200 else self.authtoken
         return response
-    
 
-       
     def logout(self):
         """
         Logging out from the stack
@@ -145,7 +143,7 @@ def logout(self):
             >>> response = client.logout()
         -------------------------------
         """
-        return UserSession(api_client = self.api_client).logout()
+        return UserSession(api_client=self.api_client).logout()
 
     def get_authtoken(self, response):
         """
@@ -160,15 +158,13 @@ def get_authtoken(self, response):
             >>> auth_token = client.get_authtoken(response)
         -------------------------------
         """
-        return response['user']['authtoken']      
-    
+        return response['user']['authtoken']
+
     def user(self):
-        return User(self.endpoint, self.auth_token, self.headers,self.api_client)
-        
-    def organizations(self, organization_uid = None):
-        return Organization(self.endpoint, self.auth_token, self.headers,self.api_client, organization_uid)
-    
-    def stack(self, api_key = None):
-        return Stack(self.endpoint, self.auth_token, self.headers,self.api_client, api_key)
-    
+        return User(self.endpoint, self.auth_token, self.headers, self.api_client)
+
+    def organizations(self, organization_uid=None):
+        return Organization(self.endpoint, self.auth_token, self.headers, self.api_client, organization_uid)
 
+    def stack(self, api_key=None):
+        return Stack(self.endpoint, self.auth_token, self.headers, self.api_client, api_key)

contentstack_management/core/client.py

@@ -5,6 +5,7 @@
 
 import json
 
+
 class Globalfields:
     """
     This class takes a base URL as an argument when it's initialized, 
@@ -38,10 +39,8 @@ def find(self):
         url = "global_fields"
         self.headers['api_key'] = self.api_key
         self.headers['authtoken'] = self.authtoken
-        return self.api_client.get(url, headers = self.headers)
-    
-      
-    
+        return self.api_client.get(url, headers=self.headers)
+
     def fetch(self):
         """
         Fetches the global fields entry 
@@ -59,9 +58,8 @@ def fetch(self):
         url = f"global_fields/{self.global_field_uid}"
         self.headers['authtoken'] = self.authtoken
         self.headers['api_key'] = self.api_key
-        return self.api_client.get(url, headers = self.headers)
-        
-    
+        return self.api_client.get(url, headers=self.headers)
+
     def create(self, data):
         """
         Create the global fields entries 
@@ -105,8 +103,8 @@ def create(self, data):
         self.headers['api_key'] = self.api_key
         self.headers['authtoken'] = self.authtoken
         data = json.dumps(data)
-        return self.api_client.post(url, headers = self.headers, data=data)
-    
+        return self.api_client.post(url, headers=self.headers, data=data)
+
     def update(self, data):
         """
         Update the global fields entries 
@@ -150,8 +148,8 @@ def update(self, data):
         self.headers['authtoken'] = self.authtoken
         self.headers['api_key'] = self.api_key
         data = json.dumps(data)
-        return self.api_client.put(url, headers = self.headers, data=data)
-    
+        return self.api_client.put(url, headers=self.headers, data=data)
+
     def delete(self):
         """
         Delete the global fields  
@@ -170,8 +168,8 @@ def delete(self):
         self.headers['authtoken'] = self.authtoken
         self.headers['api_key'] = self.api_key
         params = {'force': True}
-        return self.api_client.delete(url, headers = self.headers, params = params)
-    
+        return self.api_client.delete(url, headers=self.headers, params=params)
+
     def imports(self, file_path):
         """
         Import the global fields
@@ -192,9 +190,9 @@ def imports(self, file_path):
         self.headers['api_key'] = self.api_key
         self.headers['Content-Type'] = "multipart/form-data"
         params = {'include_branch': False}
-        files = {'global_field': open(f"{file_path}",'rb')}
-        return self.api_client.post(url, headers = self.headers, params = params, files = files)
-    
+        files = {'global_field': open(f"{file_path}", 'rb')}
+        return self.api_client.post(url, headers=self.headers, params=params, files=files)
+
     def export(self):
         """
         Export the global fields 
@@ -212,15 +210,4 @@ def export(self):
         url = f"global_fields/{self.global_field_uid}/export"
         self.headers['authtoken'] = self.authtoken
         self.headers['api_key'] = self.api_key
-        return self.api_client.get(url, headers = self.headers)
-    
-    
-    
-    
-    
-
-    
-
-    
-
-
+        return self.api_client.get(url, headers=self.headers)

contentstack_management/global_fields/global_fields.py

@@ -1,6 +1,6 @@
-
 import json
 
+
 class Organization:
     """
     This class takes a base URL as an argument when it's initialized, 
@@ -17,7 +17,6 @@ def __init__(self, endpoint, authtoken, headers, api_client, organization_uid):
         self.organization_uid = organization_uid
         self.headers['authtoken'] = self.authtoken
 
-    
     def find(self):
         """
         Finds the organizations entries 
@@ -32,8 +31,8 @@ def find(self):
         -------------------------------
         """
         url = "organizations"
-        return self.api_client.get(url, headers = self.headers)
-    
+        return self.api_client.get(url, headers=self.headers)
+
     def fetch(self):
         """
         Fetches the organizations entry
@@ -49,9 +48,8 @@ def fetch(self):
         -------------------------------
         """
         url = f"organizations/{self.organization_uid}"
-        return self.api_client.get(url, headers = self.headers)
+        return self.api_client.get(url, headers=self.headers)
 
-    
     def roles(self):
         """
         Fetches the organization roles entries 
@@ -67,9 +65,8 @@ def roles(self):
         -------------------------------
         """
         url = f"organizations/{self.organization_uid}/roles"
-        return self.api_client.get(url, headers = self.headers)
+        return self.api_client.get(url, headers=self.headers)
 
-    
     def add_users(self, user_data):
         """
         Add user to the organization 
@@ -104,8 +101,8 @@ def add_users(self, user_data):
         """
         url = f"organizations/{self.organization_uid}/share"
         data = json.dumps(user_data)
-        return self.api_client.post(url, headers = self.headers, data = data)
-    
+        return self.api_client.post(url, headers=self.headers, data=data)
+
     def transfer_ownership(self, data):
         """
         Add user to the organization 
@@ -126,9 +123,8 @@ def transfer_ownership(self, data):
 
         url = f"organizations/{self.organization_uid}/transfer-ownership"
         data = json.dumps(data)
-        return self.api_client.post(url, headers = self.headers, data = data)
+        return self.api_client.post(url, headers=self.headers, data=data)
 
-    
     def stacks(self):
         """
         Fetches the organization stacks 
@@ -144,9 +140,8 @@ def stacks(self):
         -------------------------------
         """
         url = f"organizations/{self.organization_uid}/stacks"
-        return self.api_client.get(url, headers = self.headers)
+        return self.api_client.get(url, headers=self.headers)
 
-    
     def logs(self):
         """
         Fetches the organization log entries 
@@ -162,5 +157,4 @@ def logs(self):
         -------------------------------
         """
         url = f"organizations/{self.organization_uid}/logs"
-        return self.api_client.get(url, headers = self.headers)
-
+        return self.api_client.get(url, headers=self.headers)