General Fixes

Signed-off-by: Martyn Bristow <[email protected]>

Author: martynbristow

.gitignore

@@ -0,0 +1,3 @@
+/tempo_api_python_client.egg-info
+/dist
+/build

README.md

@@ -40,6 +40,12 @@ for i in worklogs:
 There are also functions to retrieve `user` and `team`-specific worklogs.
 
 
+## Code Format
+
+- Flake8: `flake8 --max-line-length=120 tempoapiclient/*`
+
+- Pylint: `pylint --max-line-length=120 tempoapiclient`
+
 ## Contributing
 
 Contribution is welcome. See [CONTRIBUTING.md](CONTRIBUTING.md) for more details.

tempoapiclient/client.py

@@ -17,6 +17,7 @@
 
 from .rest_client import RestAPIClient
 
+
 class Tempo(RestAPIClient):
     """
     Basic Client for accessing Tempo Rest API as provided by api.tempo.io.
@@ -32,15 +33,16 @@ def _resolve_date(self, value):
             return value.date()
         if isinstance(value, date):
             return value
-    
+
         parsed = datetime.strptime(value,  r"%Y-%m-%d").date()
 
         return parsed
 
     def get(self, path, data=None, flags=None, params=None, headers=None, not_json_response=None, trailing=None):
         path_absolute = super().url_joiner(self._base_url, path)
-        resp = super().get(path_absolute, data=data, flags=flags, params=params, headers=headers, not_json_response=not_json_response, trailing=trailing)
-        
+        resp = super().get(path_absolute, data=data, flags=flags, params=params, headers=headers,
+                           not_json_response=not_json_response, trailing=trailing)
+
         # single item returned
         if 'results' not in resp:
             return resp
@@ -52,7 +54,7 @@ def get(self, path, data=None, flags=None, params=None, headers=None, not_json_r
         while 'next' in resp.get('metadata'):
             resp = super().get(resp.get('metadata').get('next'))
             results.extend(resp['results'])
-        
+
         return results
 
 # Accounts
@@ -63,34 +65,25 @@ def get_accounts(self):
         """
         return self.get("/accounts")
 
-
-# Account - Categories
-
+    # Account - Categories
     def get_account_categories(self):
         """
         Retrieves existing account categories.
         """
         return self.get("/account-categories")
 
-
-# Account - Category - Types
-
+    # Account - Category - Types
     def get_account_category_types(self):
-
         """
         Retrieves all periods for a given date range as a list.
         """
         return self.get("/account-category-types")
 
-# Account - Links
-
+    # Account - Links
     ## TBD
 
-
-# Customers
-
+    # Customers
     def get_customers(self, key=None):
-
         """
         Retrieves all customers or customer.
         :param key: Return customer for ```key```.
@@ -101,22 +94,18 @@ def get_customers(self, key=None):
             url += f"/{key}"
         return self.get(url)
 
-
-# Plans
-
+    # Plans
     def get_plans(self, dateFrom, dateTo, assigneeType=None, planItemType=None, updatedFrom=None, id=None, userId=None):
-
         """
         Retrieves plans or plan.
-        :param dateFrom: 
+        :param dateFrom:
         :param dateTo:
         :param assigneeType:
         :param planItemType:
         :param updatedFrom:
         :param id: Plan id
         :param userId: ```AccountId``` for user in Tempo
         """
-        
         params = {
             "from": self._resolve_date(dateFrom).isoformat(),
             "to": self._resolve_date(dateTo).isoformat(),
@@ -129,27 +118,21 @@ def get_plans(self, dateFrom, dateTo, assigneeType=None, planItemType=None, upda
             params['planItemType'] = planItemType
         if updatedFrom:
             params['updatedFrom'] = self._resolve_date(updatedFrom).isoformat()
-        
+
         url = "/plans"
         if id:
             url += f"/{id}"
         elif userId:
             url += f"/plans/user/{userId}"
         return self.get(url, params=params)
 
-
-# Programs
-
+    # Programs
     ## TBD
 
-
-# Roles
-
+    # Roles
     ## TBD
 
-
-# Teams
-
+    # Teams
     def get_teams(self, teamId=None):
         """
         Returns teams information.
@@ -171,13 +154,10 @@ def get_team_members(self, teamId):
         url = f"/teams/{teamId}/members"
         return self.get(url)
 
-# Team - Links
-
-## TBD
-
-
-# Team - Memberships
+    # Team - Links
+    ## TBD
 
+    # Team - Memberships
     def get_team_memberships(self, membershipId):
         """
         Returns members.
@@ -238,7 +218,6 @@ def get_timesheet_approvals(self, dateFrom=None, dateTo=None, userId=None, teamI
         :param userId:
         :param teamId:
         """
-        
         params = {}
         if dateFrom:
             params["from"] = self._resolve_date(dateFrom).isoformat()
@@ -252,8 +231,7 @@ def get_timesheet_approvals(self, dateFrom=None, dateTo=None, userId=None, teamI
             url += f"/team/{teamId}"
         return self.get(url, params=params)
 
-# User Schedule
-
+    # User Schedule
     def get_user_schedule(self, dateFrom, dateTo, userId=None):
         """
         Returns user schedule.
@@ -271,19 +249,14 @@ def get_user_schedule(self, dateFrom, dateTo, userId=None):
             url += f"/{userId}"
         return self.get(url, params=params)
 
-
-# Work Attributes
-
+    # Work Attributes
     def get_work_attributes(self):
         """
         Returns worklog attributes.
         """
-
         return self.get("/work-attributes")
 
-    
-# Workload Schemes
-
+    # Workload Schemes
     def get_workload_schemes(self, id=None):
         url = f"/workload-schemes"
         if id:
@@ -300,7 +273,8 @@ def get_holiday_schemes(self, holidaySchemeId=None):
 
 # Worklogs
 
-    def get_worklogs(self, dateFrom, dateTo, updatedFrom=None, worklogId=None, jiraWorklogId=None, jiraFilterId=None, accountKey=None, projectKey=None, teamId=None, accountId=None, issueId=None):
+    def get_worklogs(self, dateFrom, dateTo, updatedFrom=None, worklogId=None, jiraWorklogId=None, jiraFilterId=None,
+                     accountKey=None, projectKey=None, teamId=None, accountId=None, issueId=None):
         """
         Returns worklogs for particular parameters.
         :param dateFrom:

tempoapiclient/rest_client.py

@@ -7,12 +7,12 @@
 
 log = logging.getLogger()
 
+
 class RestAPIClient(object):
     default_headers = {'Content-Type': 'application/json', 'Accept': 'application/json'}
     response = None
 
     def __init__(self, url="", auth_token=None, timeout=None, verify_ssl=None, proxies=None, advanced_mode=None):
-        
         self._url = url
         self._auth_token = auth_token
         self._timeout = timeout
@@ -21,7 +21,7 @@ def __init__(self, url="", auth_token=None, timeout=None, verify_ssl=None, proxi
         self._advanced_mode = advanced_mode
         self._session = requests.Session()
         self._update_header("Authorization", "Bearer {}".format(auth_token))
-        
+
     def __enter__(self):
         return self
 
@@ -41,7 +41,7 @@ def _response_handler(self, response):
 
         if self._advanced_mode:
             return response
-        
+
         try:
             # If the response was successful, no Exception will be raised
             response.raise_for_status()
@@ -57,7 +57,7 @@ def _response_handler(self, response):
     @staticmethod
     def url_joiner(url, path, trailing=None):
         url_link = path
-        if url:    
+        if url:
             url_link = '/'.join(s.strip('/') for s in [url, path])
         if trailing:
             url_link += '/'
@@ -67,7 +67,7 @@ def close(self):
         return self._session.close()
 
     def _request(self, method='GET', path='/', data=None, json=None, flags=None, params=None, headers=None,
-                files=None, trailing=None):
+                 files=None, trailing=None):
         """
 
         :param method:
@@ -92,7 +92,6 @@ def _request(self, method='GET', path='/', data=None, json=None, flags=None, par
         if files is None:
             data = None if not data else dumps(data)
             json_dump = None if not json else dumps(json)
-        
 
         headers = headers or self.default_headers
         response = self._session.request(
@@ -123,30 +122,26 @@ def get(self, path, data=None, flags=None, params=None, headers=None, not_json_r
         :param trailing: OPTIONAL: for wrap slash symbol in the end of string
         :return:
         """
-        
         response = self._request('GET', path=path, flags=flags, params=params, data=data, headers=headers,
-                                trailing=trailing)
+                                 trailing=trailing)
 
         return self._response_handler(response)
 
     def post(self, path, data=None, json=None, headers=None, files=None, params=None, trailing=None):
         response = self._request('POST', path=path, data=data, json=json, headers=headers, files=files, params=params,
-                                trailing=trailing)
-        
+                                 trailing=trailing)
         return self._response_handler(response)
 
     def put(self, path, data=None, headers=None, files=None, trailing=None, params=None):
         response = self._request('PUT', path=path, data=data, headers=headers, files=files, params=params,
-                                trailing=trailing)
+                                 trailing=trailing)
         return self._response_handler(response)
 
-
     def delete(self, path, data=None, headers=None, params=None, trailing=None):
         """
         Deletes resources at given paths.
         :rtype: dict
         :return: Empty dictionary to have consistent interface.
         """
         response = self._request('DELETE', path=path, data=data, headers=headers, params=params, trailing=trailing)
-        
         return self._response_handler(response)