rara-tools 0.0.2__tar.gz → 0.0.4__tar.gz

{rara_tools-0.0.2/rara_tools.egg-info → rara_tools-0.0.4}/PKG-INFO

@@ -1,6 +1,6 @@
-Metadata-Version: 2.1
+Metadata-Version: 2.2
 Name: rara-tools
-Version: 0.0.2
+Version: 0.0.4
 Summary: Tools to support Kata's work.
 Classifier: Programming Language :: Python :: 3
 Classifier: Programming Language :: Python :: 3.10

rara_tools-0.0.4/VERSION

@@ -0,0 +1 @@
+0.0.4

{rara_tools-0.0.2 → rara_tools-0.0.4}/rara_tools/s3.py

@@ -1,6 +1,7 @@
 import os
 import uuid
-from typing import Optional, List, Generator
+from typing import Optional, List, Generator, Any
+
 from minio import Minio
 
 from .exceptions import S3InitException, S3ConnectionException, S3InputException
@@ -15,8 +16,9 @@ class S3Files:
             url: Optional[str] = None,
             access_key: Optional[str] = None,
             secret_key: Optional[str] = None,
-            bucket: Optional[str] = None
-        ):
+            bucket: Optional[str] = None,
+            **minio_kwargs: dict[str, Any],
+    ):
         if not url:
             raise S3InitException("S3 URL not set!")
         if not access_key:
@@ -24,12 +26,13 @@ class S3Files:
         if not secret_key:
             raise S3InitException("S3 secret key not set!")
         if not bucket:
-            raise S3InitException("Bucket not set!")      
+            raise S3InitException("Bucket not set!")
         self.bucket = bucket
         self.minio_client = Minio(
             url,
             access_key=access_key,
-            secret_key=secret_key
+            secret_key=secret_key,
+            **minio_kwargs
         )
         # Check S3 connection
         try:
@@ -42,12 +45,13 @@ class S3Files:
             raise S3InputException(f"File '{file_path}' does not exist in file system!")
         return self.minio_client.fput_object(self.bucket, s3_path_name, file_path)
 
-    def list(self, prefix: Optional[str] = "") -> List:
-        """Lists all available files in S3 bucket.
+    def list(self, prefix: Optional[str] = "", recursive: Optional[bool] = True) -> List:
+        """Lists all available directories or files in S3 bucket.
         :param: prefix str: Limits the listing to a given prefix.
+        :param: recursive bool: List files recursively.
         :return: List of file paths in S3.
         """
-        list_of_objects = self.minio_client.list_objects(self.bucket, prefix=prefix, recursive=True)
+        list_of_objects = self.minio_client.list_objects(self.bucket, prefix=prefix, recursive=recursive)
         list_of_objects = [o.object_name for o in list_of_objects]
         return list_of_objects
 

{rara_tools-0.0.2 → rara_tools-0.0.4}/rara_tools/task_reporter.py

@@ -1,6 +1,7 @@
-import requests
 from typing import Optional
 
+import requests
+
 from .exceptions import TaskReporterException
 
 
@@ -10,11 +11,12 @@ class TaskReporter:
     * running instance of Core API,
     * Core API access token with sufficient privileges.
     """
+
     def __init__(
-        self,
-        api_url: str,
-        api_token: str,
-        api_timeout: Optional[int] = 10,
+            self,
+            api_url: str,
+            api_token: str,
+            api_timeout: Optional[int] = 10,
     ):
         # Remove possible trailing / from API url.
         self.api_url = api_url.rstrip("/")
@@ -35,14 +37,26 @@ class TaskReporter:
             return True
         return False
 
-    def _perform_patch(self, content: dict, task_id: int):
-        url = f"{self.api_url}/tasks/{task_id}/"
+    def _perform_patch(self, content: dict, task_id: int, tasks_endpoint: str = "tasks"):
+        url = f"{self.api_url}/{tasks_endpoint}/{task_id}/"
         try:
             return requests.patch(
                 url,
-                headers = self.api_headers,
-                json = content,
-                timeout = self.api_timeout
+                headers=self.api_headers,
+                json=content,
+                timeout=self.api_timeout
+            )
+        except Exception as e:
+            raise TaskReporterException(f"Error patching document: {e}")
+
+    def _perform_status_update(self, content: dict, task_id: int, tasks_endpoint: str = "tasks", action_endpoint: str = "update_status"):
+        url = f"{self.api_url}/{tasks_endpoint}/{task_id}/{action_endpoint}/"
+        try:
+            return requests.post(
+                url,
+                headers=self.api_headers,
+                json=content,
+                timeout=self.api_timeout
             )
         except Exception as e:
             raise TaskReporterException(f"Error patching document: {e}")
@@ -57,3 +71,15 @@ class TaskReporter:
         if response.status_code not in (200, 204):
             raise TaskReporterException(f"Error code from Core API: {response.status_code}")
         return response
+
+    def update_status(self, key: str, task_id: int, **status_options):
+        """Updates the status of sub-tasks to Core API.
+        :param: key: Since task statuses are Many-to-Many a normal patch won't work, hence we filter the status we want through the key.
+        :param: status_options: Keys & values to update in the status model.
+        :return: Response object.
+        """
+        content = {"key": key, **status_options}
+        response = self._perform_status_update(content, task_id)
+        if response.status_code not in (200, 204):
+            raise TaskReporterException(f"Error code from Core API: {response.status_code}")
+        return response

{rara_tools-0.0.2 → rara_tools-0.0.4/rara_tools.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
-Metadata-Version: 2.1
+Metadata-Version: 2.2
 Name: rara-tools
-Version: 0.0.2
+Version: 0.0.4
 Summary: Tools to support Kata's work.
 Classifier: Programming Language :: Python :: 3
 Classifier: Programming Language :: Python :: 3.10

rara_tools-0.0.2/VERSION

@@ -1 +0,0 @@
-0.0.2