brynq-sdk-jira 2.0.0__tar.gz → 2.1.1__tar.gz

{brynq_sdk_jira-2.0.0 → brynq_sdk_jira-2.1.1}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 1.0
 Name: brynq_sdk_jira
-Version: 2.0.0
+Version: 2.1.1
 Summary: JIRA wrapper from BrynQ
 Home-page: UNKNOWN
 Author: BrynQ

{brynq_sdk_jira-2.0.0 → brynq_sdk_jira-2.1.1}/brynq_sdk_jira/jira.py

@@ -14,6 +14,7 @@ class Jira(BrynQ):
             "Content-Type": "application/json"
         }
         self.debug = debug
+        self.timeout = 3600
 
     def get_issues(self, jql_filter: str = None, jira_filter_id: int = None, get_extra_fields: list = None, expand_fields: list = None) -> pd.DataFrame:
         """
@@ -46,7 +47,7 @@ class Jira(BrynQ):
                 url = f"{self.base_url}rest/api/3/search/jira/filter/{jira_filter_id}"
             else:
                 url = f"{self.base_url}rest/api/3/search"
-            response = requests.post(url=url, headers=self.headers, data=json.dumps(query))
+            response = requests.post(url=url, headers=self.headers, data=json.dumps(query), timeout=self.timeout)
             if response.status_code == 200:
                 response_json = response.json()
                 no_of_loops += 1
@@ -79,7 +80,7 @@ class Jira(BrynQ):
             }
             if self.debug:
                 print(query)
-            response = requests.get(f"{self.base_url}rest/api/3/project/search", headers=self.headers, params=query)
+            response = requests.get(f"{self.base_url}rest/api/3/project/search", headers=self.headers, params=query, timeout=self.timeout)
             if response.status_code == 200:
                 response_json = response.json()
                 response.raise_for_status()
@@ -103,7 +104,7 @@ class Jira(BrynQ):
         :return: A dataframe with the versions.
         """
         url = f"{self.base_url}rest/api/latest/project/{project_key}/versions"
-        response = requests.get(url=url, headers=self.headers)
+        response = requests.get(url=url, headers=self.headers, timeout=self.timeout)
         if response.status_code == 200:
             response_json = response.json()
             df = pd.json_normalize(response_json)
@@ -111,4 +112,34 @@ class Jira(BrynQ):
                 print(f"Received {len(df)} versions for project {project_key}")
             return df
         else:
-            raise ConnectionError(f"Error getting versions from Jira with message: {response.status_code, response.text}")
+            raise ConnectionError(f"Error getting versions from Jira with message: {response.status_code, response.text}")
+
+    def get_users(self) -> pd.DataFrame:
+        """
+        This method retrieves users from Jira.
+        :return: a dataframe with users
+        """
+        start_at = 0
+        max_results = 50
+        all_users = []
+
+        while True:
+            response = requests.get(f"{self.base_url}rest/api/3/users/search?startAt={start_at}&maxResults={max_results}", headers=self.headers, timeout=self.timeout)
+            response.raise_for_status()
+            if response.status_code == 200:
+                users = response.json()  # A list of user objects
+                all_users.extend(users)  # Add users to the total list
+
+                # Stop if no more users are returned
+                if not users:
+                    break
+
+                # Increment startAt for the next page
+                start_at += len(users)
+            else:
+                raise ConnectionError(f"Error getting users from Jira with message: {response.status_code, response.text}")
+            if self.debug:
+                print(f"Received {len(all_users)} jira users from Jira")
+
+        df = pd.json_normalize(all_users)
+        return df

brynq_sdk_jira-2.1.1/brynq_sdk_jira/tempo.py

@@ -0,0 +1,189 @@
+import json
+import requests
+from itertools import islice
+from brynq_sdk_brynq import BrynQ
+from typing import Union, List
+
+
+class Tempo(BrynQ):
+    def __init__(self, label: Union[str, List], debug=False):
+        super().__init__()
+        self.debug = debug
+        credentials = self.get_system_credential(system='tempo-timesheets', label=label)
+        self.headers = {
+            "Authorization": f"Bearer {credentials['api_token']}",
+            "Content-Type": "application/json"
+        }
+        if self.debug:
+            print(self.headers)
+        self.timeout = 3600
+
+    def get_tempo_hours(self, from_date: str = None, to_date: str = None, updated_from: str = None) -> json:
+        """
+        This function gets hours from Tempo for the specified time period
+
+        :param from_date: (Optional) string - retrieve results starting with this date
+        :param to_date: (Optional) string - retrieve results up to and including this date
+        :param updated_from: (Optional) string <yyyy-MM-dd['T'HH:mm:ss]['Z']> - retrieve results that have been updated from this date(e.g "2023-11-16") or date time (e.g "2023-11-06T16:48:59Z")
+        :return: json response with results
+        """
+        total_response = []
+        got_all_results = False
+        no_of_loops = 0
+        parameters = {}
+        if from_date is not None:
+            parameters.update({"from": from_date})
+        if to_date is not None:
+            parameters.update({"to": to_date})
+        if updated_from is not None:
+            parameters.update({"updatedFrom": updated_from})
+
+        while not got_all_results:
+            loop_parameters = parameters | {"limit": 1000, "offset": 1000 * no_of_loops}
+            response = requests.get('https://api.tempo.io/4/worklogs', headers=self.headers, params=loop_parameters, timeout=self.timeout)
+            if response.status_code == 200:
+                response_json = response.json()
+                no_of_loops += 1
+                got_all_results = False if int(response_json['metadata']['count']) == 1000 else True
+                total_response += response_json['results']
+            else:
+                raise ConnectionError(f"Error getting worklogs from Tempo: {response.status_code, response.text}")
+
+        if self.debug:
+            print(f"Received {len(total_response)} lines from Tempo")
+
+        return total_response
+
+    def get_tempo_teams(self, team_members: List[str] = None, name: str = None) -> json:
+        """
+        Fetches teams from the Tempo API in smaller batches to prevent long URLs if team_members is specified,
+        otherwise, retrieves a list of all existing Teams.
+
+        :param team_members: (Optional) List of Jira user account IDs to filter teams.
+        :param name: (Optional) Name of the team to filter teams.
+        :return: A json response containing team details.
+        """
+        total_response = []
+
+        # Split team members into smaller chunks (avoid long URLs)
+        team_member_chunks = self._chunk_list(team_members, 50) if team_members else [None]
+
+        for team_chunk in team_member_chunks:
+            parameters = {"limit": 1000, "offset": 0}
+            if team_chunk:
+                parameters["teamMembers"] = ",".join(team_chunk)  # Send fewer team members at a time
+            if name:
+                parameters["name"] = name
+            got_all_results = False
+            no_of_loops = 0
+
+            while not got_all_results:
+                parameters["offset"] = 1000 * no_of_loops
+                response = requests.get('https://api.tempo.io/4/teams', headers=self.headers, params=parameters, timeout=self.timeout)
+                if response.status_code == 200:
+                    response_json = response.json()
+                    total_response.extend(response_json["results"])
+                    got_all_results = False if int(response_json['metadata']['count']) == 1000 else True
+                    no_of_loops += 1
+                else:
+                    raise ConnectionError(f"Error getting teams from Tempo: {response.status_code}, {response.text}")
+
+        if self.debug:
+            print(f"Received {len(total_response)} teams from Tempo")
+        return total_response
+
+    def get_tempo_team_members(self, team_ids: List[int]) -> json:
+        """
+        Fetches members of multiple teams from the Tempo API iteratively.
+
+        :param team_ids: List of Tempo team IDs to retrieve members from.
+        :return: A json response containing team members' details.
+        """
+        total_response = []
+
+        for team_id in team_ids:
+            got_all_results = False
+            no_of_loops = 0
+
+            while not got_all_results:
+                parameters = {"limit": 1000, "offset": 1000 * no_of_loops}
+                response = requests.get(f'https://api.tempo.io/4/teams/{team_id}/members', headers=self.headers, params=parameters, timeout=self.timeout)
+                if response.status_code == 200:
+                    response_json = response.json()
+                    total_response.extend(response_json["results"])
+                    got_all_results = False if int(response_json.get('metadata', {}).get('count', 0)) == 1000 else True
+                    no_of_loops += 1
+                else:
+                    raise ConnectionError(f"Error getting team members from Tempo: {response.status_code}, {response.text}")
+
+        if self.debug:
+            print(f"Received {len(total_response)} team members from Tempo")
+        return total_response
+
+    def get_accounts(self) -> json:
+        """
+        Fetches account details from the Tempo API in batches to handle large datasets.
+
+        :return: A json object containing account details.
+        """
+        total_response = []
+        got_all_results = False
+        no_of_loops = 0
+        parameters = {}
+
+        while not got_all_results:
+            loop_parameters = parameters | {"limit": 1000, "offset": 1000 * no_of_loops}
+            response = requests.get('https://api.tempo.io/4/accounts', headers=self.headers, params=loop_parameters, timeout=self.timeout)
+            if response.status_code == 200:
+                response_json = response.json()
+                no_of_loops += 1
+                got_all_results = False if int(response_json['metadata']['count']) == 1000 else True
+                total_response += response_json['results']
+            else:
+                raise ConnectionError(f"Error getting accounts from Tempo: {response.status_code}, {response.text}")
+
+        if self.debug:
+            print(f"Received {len(total_response)} accounts from Tempo")
+        return total_response
+
+    def get_worklog_accounts(self, account_key: str, from_date: str = None, to_date: str = None, updated_from: str = None) -> json:
+        """
+        Fetches worklog data for a given account key from the Tempo API.
+
+        :param account_key: (Required) string - The account key for which worklog data is required.
+        :param from_date: (Optional) string - retrieve results starting with this date
+        :param to_date: (Optional) string - retrieve results up to and including this date
+        :param updated_from: (Optional) string <yyyy-MM-dd['T'HH:mm:ss]['Z']> - retrieve results that have been updated from this date(e.g "2023-11-16") or date time (e.g "2023-11-06T16:48:59Z")
+        :return: A json containing worklog details.
+        """
+        total_response = []
+        got_all_results = False
+        no_of_loops = 0
+        parameters = {}
+        if from_date is not None:
+            parameters.update({"from": from_date})
+        if to_date is not None:
+            parameters.update({"to": to_date})
+        if updated_from is not None:
+            parameters.update({"updatedFrom": updated_from})
+
+        while not got_all_results:
+            loop_parameters = parameters | {"limit": 1000, "offset": 1000 * no_of_loops}
+            response = requests.get(f"https://api.tempo.io/4/worklogs/account/{account_key}", headers=self.headers, params=loop_parameters, timeout=self.timeout)
+            if response.status_code == 200:
+                response_json = response.json()
+                total_response.extend(response_json.get("results", []))
+                got_all_results = False if int(response_json.get('metadata', {}).get('count', 0)) == 1000 else True
+                no_of_loops += 1
+            else:
+                raise ConnectionError(f"Failed to fetch data for account key {account_key}: {response.status_code}, {response.text}")
+
+        if self.debug:
+            print(f"Received {len(total_response)} worklogs for account key {account_key}")
+
+        return total_response
+
+    def _chunk_list(self, data_list, chunk_size):
+        """Splits a list into chunks of `chunk_size`."""
+        it = iter(data_list)
+        return iter(lambda: list(islice(it, chunk_size)), [])

{brynq_sdk_jira-2.0.0 → brynq_sdk_jira-2.1.1}/brynq_sdk_jira.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 1.0
 Name: brynq-sdk-jira
-Version: 2.0.0
+Version: 2.1.1
 Summary: JIRA wrapper from BrynQ
 Home-page: UNKNOWN
 Author: BrynQ

{brynq_sdk_jira-2.0.0 → brynq_sdk_jira-2.1.1}/setup.py

@@ -2,7 +2,7 @@ from setuptools import setup, find_namespace_packages
 
 setup(
     name='brynq_sdk_jira',
-    version='2.0.0',
+    version='2.1.1',
     description='JIRA wrapper from BrynQ',
     long_description='JIRA wrapper from BrynQ',
     author='BrynQ',

brynq_sdk_jira-2.0.0/brynq_sdk_jira/tempo.py

@@ -1,50 +0,0 @@
-import json
-import requests
-from typing import Union, List
-from brynq_sdk_brynq import BrynQ
-
-class Tempo(BrynQ):
-    def __init__(self, label: Union[str, List], debug=False):
-        super().__init__()
-        self.debug = debug
-        credentials = self.get_system_credential(system='tempo-timesheets', label=label)
-        self.headers = {
-            "Authorization": f"Bearer {credentials['api_token']}",
-            "Content-Type": "application/json"
-        }
-        if self.debug:
-            print(self.headers)
-
-    def get_tempo_hours(self, from_date: str = None, to_date: str = None, updated_from: str = None) -> json:
-        """
-        This function gets hours from Tempo for max 8 backs week
-        :param from_date:
-        :param to_date:
-        :return: json response with results
-        """
-        total_response = []
-        got_all_results = False
-        no_of_loops = 0
-        parameters = {}
-        if from_date is not None:
-            parameters.update({"from": from_date})
-        if to_date is not None:
-            parameters.update({"to": to_date})
-        if updated_from is not None:
-            parameters.update({"updatedFrom": updated_from})
-
-        while not got_all_results:
-            loop_parameters = parameters | {"limit": 1000, "offset": 1000 * no_of_loops}
-            response = requests.get('https://api.tempo.io/4/worklogs', headers=self.headers, params=loop_parameters)
-            if response.status_code == 200:
-                response_json = response.json()
-                no_of_loops += 1
-                got_all_results = False if int(response_json['metadata']['count']) == 1000 else True
-                total_response += response_json['results']
-            else:
-                raise ConnectionError(f"Error getting worklogs from Tempo: {response.status_code, response.text}")
-
-        if self.debug:
-            print(f"Received {len(total_response)} lines from Tempo")
-
-        return total_response