accli 1.0.3__tar.gz → 1.1.0__tar.gz

{accli-1.0.3 → accli-1.1.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: accli
-Version: 1.0.3
+Version: 1.1.0
 Summary: IIASA Accelerator Client
 Author-email: Wrufesh S <wrufesh@gmail.com>
 License: The MIT License (MIT)
@@ -38,6 +38,7 @@ Requires-Dist: tinydb>=4.5.2
 Requires-Dist: requests>=2.25.1
 Requires-Dist: jsonschema>=4.5.1
 Requires-Dist: pydantic>=2.0
+Requires-Dist: GitPython
 Dynamic: license-file
 
 
@@ -71,6 +72,22 @@ This client uses **device authentication** via Auth0.
 
 ### 📦 Installation
 
+#### Option 1: Standalone Binaries (Recommended)
+
+No Python install required. Run the appropriate command for your system:
+
+**Linux / macOS:**
+```bash
+curl -fsSL https://raw.githubusercontent.com/iiasa/accli/master/scripts/install.sh | bash
+```
+
+**Windows (PowerShell):**
+```powershell
+irm https://raw.githubusercontent.com/iiasa/accli/master/scripts/install.ps1 | iex
+```
+
+#### Option 2: Via PIP
+
 ```bash
 pip install accli --user
 ```

{accli-1.0.3 → accli-1.1.0}/README.md

@@ -29,6 +29,22 @@ This client uses **device authentication** via Auth0.
 
 ### 📦 Installation
 
+#### Option 1: Standalone Binaries (Recommended)
+
+No Python install required. Run the appropriate command for your system:
+
+**Linux / macOS:**
+```bash
+curl -fsSL https://raw.githubusercontent.com/iiasa/accli/master/scripts/install.sh | bash
+```
+
+**Windows (PowerShell):**
+```powershell
+irm https://raw.githubusercontent.com/iiasa/accli/master/scripts/install.ps1 | iex
+```
+
+#### Option 2: Via PIP
+
 ```bash
 pip install accli --user
 ```

{accli-1.0.3 → accli-1.1.0}/accli/AcceleratorJobProjectService.py

@@ -1,19 +1,19 @@
 import os
 import io
-import sys
-import typing
+from typing import Union, List, Tuple
+
 import requests
 import json
 import base64
 import urllib3
 from urllib.parse import quote
 from pathlib import Path
-from typing import List, Tuple
 
 from accli.common import todict
 
 ACCLI_DEBUG = os.environ.get('ACCLI_DEBUG', False)
 
+
 class AccAPIError(Exception):
     pass
 
@@ -33,14 +33,15 @@ http_client_wo_cert_verification = urllib3.poolmanager.PoolManager(
     cert_reqs="CERT_NONE", num_pools=20, retries=retries, maxsize=2000, block=True
 )
 
+
 class AcceleratorJobProjectService:
     def __init__(
             self,
-            user_token, 
+            user_token,
             server_url='http://accelerator.iiasa.ac.at',
             verify_cert=(not ACCLI_DEBUG)
-        ):
-        
+    ):
+
         self.user_token = user_token
 
         if verify_cert:
@@ -48,13 +49,13 @@ class AcceleratorJobProjectService:
         else:
             self.http_client = http_client_wo_cert_verification
 
-        self.cli_base_url = f"{server_url}/v1/ajob-cli"
+        self.cli_base_url = f"{server_url}/api/v1/ajob-cli"
         self.common_request_headers = {
             'x-authorization': user_token
         }
 
     def http_client_request(self, *args, **kwargs):
-        
+
         if urllib3.__version__.startswith('1.'):
             if 'json' in kwargs:
                 json_dict = kwargs.pop('json')
@@ -66,106 +67,109 @@ class AcceleratorJobProjectService:
                 encoded_data = json.dumps(json_dict).encode('utf-8')
 
                 kwargs['body'] = encoded_data
-        
+
         res = self.http_client.request(*args, **kwargs)
 
         if str(res.status)[0] in ['4', '5']:
             raise AccAPIError(
-                f"Accelerator api error:: status_code={res.status} :: response_data={res.data}", 
+                f"Accelerator api error:: status_code={res.status} :: response_data={res.data}",
             )
         return res
 
     def get_file_stat(self, bucket_object_id):
         res = self.http_client_request(
-            "GET", 
+            "GET",
             f"{self.cli_base_url}/file-stat/{bucket_object_id}",
             headers=self.common_request_headers
         )
         return todict(res.data)
-    
-    
+
     def enumerate_files_by_prefix(self, prefix):
-        project_slug = filename.split('/')[0]
+        raise NotImplementedError("filename parameter is not implemented yet")
 
+        project_slug = filename.split('/')[0]
 
         b64_encoded_prefix = base64.b64encode(prefix.encode()).decode()
 
         res = self.http_client_request(
-            "GET", 
+            "GET",
             f"{self.cli_base_url}/{project_slug}/enumerate-all-files/{b64_encoded_prefix}",
             headers=self.common_request_headers
         )
         if res.data:
             return todict(res.data)
-    
-    
+
     def get_file_url_from_repo(self, filename):
         project_slug = filename.split('/')[0]
         res = self.http_client_request(
-            "GET", 
+            "GET",
             f"{self.cli_base_url}/{project_slug}/get-file-download-url/?filename={filename}",
             headers=self.common_request_headers
         )
         if res.data:
             return todict(res.data)
-    
+        return None
+
     def get_dataset_type(self, *args, **kwargs):
         return self.get_bucket_object_validation_type(*args, **kwargs)
 
     def get_bucket_object_validation_type(self, bucket_object_id):
         res = self.http_client_request(
-            "GET", 
+            "GET",
             f"{self.cli_base_url}/dataset-type/{bucket_object_id}",
             headers=self.common_request_headers
         )
         if res.data:
             return todict(res.data)
-
+        return None
 
     def get_filename_dataset_type(self, filename):
         res = self.http_client_request(
-            "GET", 
+            "GET",
             f"{self.cli_base_url}/filename-dataset-type/?filename={filename}",
             headers=self.common_request_headers
         )
         if res.data:
             return todict(res.data)
+        return None
 
     def get_filename_validation_details(self, filename):
         res = self.http_client_request(
-            "GET", 
+            "GET",
             f"{self.cli_base_url}/filename-validation-detail/?filename={filename}",
             headers=self.common_request_headers
         )
         if res.data:
             return todict(res.data)
+        return None
 
     def get_bucket_object_validation_details(self, bucket_object_id):
         res = self.http_client_request(
-            "GET", 
+            "GET",
             f"{self.cli_base_url}/validation-detail/{bucket_object_id}",
             headers=self.common_request_headers
         )
         if res.data:
             return todict(res.data)
+        return None
 
-    
     def get_file_url(self, bucket_object_id):
         res = self.http_client_request(
-            "GET", 
+            "GET",
             f"{self.cli_base_url}/file-url/{bucket_object_id}",
             headers=self.common_request_headers
         )
 
         if res.data:
             return todict(res.data)
-
+        return None
 
     def get_file_stream(self, bucket_object_id):
         url = self.get_file_url(bucket_object_id)
         if url:
             resp = self.http_client_request("GET", url, preload_content=False)
             return resp
+        return None
 
     def check_job_health(self):
 
@@ -174,15 +178,15 @@ class AcceleratorJobProjectService:
             f"{self.cli_base_url}/is-healthy/",
             headers=self.common_request_headers
         )
-    
+
         if res.data:
             res = todict(res.data)
-        
+
         is_healthy = res['is_healthy']
         return is_healthy
-        
+
     def add_log_file(self, data: bytes, filename):
-        
+
         res = self.http_client_request(
             "GET",
             f"{self.cli_base_url}/presigned-log-upload-url/?filename={filename}",
@@ -193,7 +197,7 @@ class AcceleratorJobProjectService:
             res = todict(res.data)
         else:
             raise ValueError(f"Unable to get presign url in response: {res.data}")
-        
+
         upload_url = res['upload_url']
         app_bucket_id = res['app_bucket_id']
         res_filename = res['filename']
@@ -206,7 +210,6 @@ class AcceleratorJobProjectService:
             verify=False,
         )
 
-        
         self.http_client_request(
             "POST",
             f"{self.cli_base_url}/register-log-file/",
@@ -216,19 +219,18 @@ class AcceleratorJobProjectService:
             ),
             headers=self.common_request_headers
         )
-        
-        return is_healthy
 
+        return is_healthy
 
     def get_multipart_put_create_signed_url(
-        self,
-        app_bucket_id,
-        object_name,
-        upload_id,
-        part_number
+            self,
+            app_bucket_id,
+            object_name,
+            upload_id,
+            part_number
     ):
         res = self.http_client_request(
-            "GET", 
+            "GET",
             f"{self.cli_base_url}/put-create-signed-url",
             fields=dict(
                 app_bucket_id=app_bucket_id,
@@ -242,13 +244,13 @@ class AcceleratorJobProjectService:
         return todict(res.data)
 
     def get_multipart_put_update_signed_url(
-        self,
-        filename,
-        upload_id,
-        part_number,
+            self,
+            filename,
+            upload_id,
+            part_number,
     ):
         res = self.http_client_request(
-            "GET", 
+            "GET",
             f"{self.cli_base_url}/put-update-signed-url",
             fields=dict(
                 filename=filename,
@@ -263,7 +265,7 @@ class AcceleratorJobProjectService:
     def get_put_create_multipart_upload_id(self, filename):
         encoded_filename = quote(filename)
         res = self.http_client_request(
-            "GET", 
+            "GET",
             f"{self.cli_base_url}/multipart-upload-id/?filename={encoded_filename}",
             headers=self.common_request_headers
         )
@@ -272,11 +274,10 @@ class AcceleratorJobProjectService:
 
         return data['upload_id'], data['app_bucket_id'], data['uniqified_filename']
 
-
     def get_validator_create_multipart_upload_id(self, filename):
         encoded_filename = quote(filename)
         res = self.http_client_request(
-            "GET", 
+            "GET",
             f"{self.cli_base_url}/validator-multipart-upload-id/?filename={encoded_filename}",
             headers=self.common_request_headers
         )
@@ -288,7 +289,7 @@ class AcceleratorJobProjectService:
     def get_put_update_multipart_upload_id(self, filename):
         encoded_filename = quote(filename)
         res = self.http_client_request(
-            "GET", 
+            "GET",
             f"{self.cli_base_url}/update-multipart-upload-id/?filename={encoded_filename}",
             headers=self.common_request_headers
         )
@@ -296,19 +297,19 @@ class AcceleratorJobProjectService:
         return todict(res.data)
 
     def complete_job_multipart_upload(
-        self,
-        app_bucket_id,
-        filename,
-        upload_id,
-        parts: List[Tuple[str, str]],
-        is_log_file=False
+            self,
+            app_bucket_id,
+            filename,
+            upload_id,
+            parts: List[Tuple[str, str]],
+            is_log_file=False
     ):
         headers = {"Content-Type": "application/json"}
 
         headers.update(self.common_request_headers)
 
         res = self.http_client_request(
-            "PUT", 
+            "PUT",
             f"{self.cli_base_url}/complete-create-multipart-upload",
             json=dict(
                 app_bucket_id=app_bucket_id,
@@ -322,20 +323,19 @@ class AcceleratorJobProjectService:
 
         return todict(res.data)
 
-
     def complete_validator_multipart_upload(
-        self,
-        app_bucket_id,
-        filename,
-        upload_id,
-        parts: List[Tuple[str, str]]
+            self,
+            app_bucket_id,
+            filename,
+            upload_id,
+            parts: List[Tuple[str, str]]
     ):
         headers = {"Content-Type": "application/json"}
 
         headers.update(self.common_request_headers)
 
         res = self.http_client_request(
-            "PUT", 
+            "PUT",
             f"{self.cli_base_url}/complete-validator-multipart-upload",
             json=dict(
                 app_bucket_id=app_bucket_id,
@@ -349,7 +349,7 @@ class AcceleratorJobProjectService:
         return todict(res.data)
 
     def complete_update_multipart_upload(
-        self, filename, upload_id, parts: List[Tuple[str, str]]
+            self, filename, upload_id, parts: List[Tuple[str, str]]
     ):
 
         headers = {"Content-Type": "application/json"}
@@ -357,7 +357,7 @@ class AcceleratorJobProjectService:
         headers.update(self.common_request_headers)
 
         res = self.http_client_request(
-            "PUT", 
+            "PUT",
             f"{self.cli_base_url}/complete-update-multipart-upload",
             json=dict(
                 filename=filename,
@@ -370,13 +370,13 @@ class AcceleratorJobProjectService:
         return todict(res.data)
 
     def abort_create_multipart_upload(self, app_bucket_id, filename, upload_id):
-        
+
         headers = {"Content-Type": "application/json"}
 
         headers.update(self.common_request_headers)
 
         res = self.http_client_request(
-            "PUT", 
+            "PUT",
             f"{self.cli_base_url}/abort-create-multipart-upload",
             json=dict(
                 app_bucket_id=app_bucket_id,
@@ -387,7 +387,7 @@ class AcceleratorJobProjectService:
         )
 
     def abort_update_multipart_upload(self, filename, upload_id):
-        
+
         headers = {
             # "Content-Type": "application/json"
         }
@@ -395,7 +395,7 @@ class AcceleratorJobProjectService:
         headers.update(self.common_request_headers)
 
         res = self.http_client_request(
-            "PUT", 
+            "PUT",
             f"{self.cli_base_url}/abort-update-multipart-upload",
             json=dict(
                 filename=filename,
@@ -403,7 +403,7 @@ class AcceleratorJobProjectService:
             ),
             headers=headers
         )
-   
+
     # # TODO @wrufesh ensure it requires special token
     # def register_iamc_validation(
     #     self, validated_bucket_object_id, indexdb_bucket_object_id
@@ -424,18 +424,18 @@ class AcceleratorJobProjectService:
     #     )
 
     def register_validation(
-        self, 
-        validated_bucket_object_id: int,
-        dataset_template_id: int,
-        validated_metadata: dict,
-        validation_supporting_bucket_object_ids: List[int]
+            self,
+            validated_bucket_object_id: int,
+            dataset_template_id: int,
+            validated_metadata: dict,
+            validation_supporting_bucket_object_ids: List[int]
     ):
         headers = {"Content-Type": "application/json"}
 
         headers.update(self.common_request_headers)
 
         res = self.http_client_request(
-            "PUT", 
+            "PUT",
             f"{self.cli_base_url}/register-validation",
             json=dict(
                 validated_bucket_object_id=validated_bucket_object_id,
@@ -447,25 +447,23 @@ class AcceleratorJobProjectService:
         )
 
     def get_dataset_template_details(
-        self, 
-        dataset_template_id
+            self,
+            dataset_template_id
     ):
         headers = {"Content-Type": "application/json"}
 
         headers.update(self.common_request_headers)
 
         res = self.http_client_request(
-            "GET", 
+            "GET",
             f"{self.cli_base_url}/dataset-template-detail/{dataset_template_id}",
             headers=headers
         )
 
         return todict(res.data)
 
-      
-
     def read_part_data(self, stream, size, part_data=b"", progress=None):
-        """Read part data of given size from stream."""
+        """Read part data of the given size from the stream."""
         size -= len(part_data)
         while size:
             data = stream.read(size)
@@ -483,7 +481,7 @@ class AcceleratorJobProjectService:
         headers = dict()
         headers["Content-Type"] = "application/octet-stream"
 
-        part_size, part_count = 50 * 1024**2, -1
+        part_size, part_count = 50 * 1024 ** 2, -1
 
         upload_id = None
         app_bucket_id = None
@@ -507,7 +505,7 @@ class AcceleratorJobProjectService:
                 )
 
                 # If part_data_size is less or equal to part_size,
-                # then we have reached last part.
+                # then we have reached the last part.
                 if len(part_data) <= part_size:
                     part_count = part_number
                     stop = True
@@ -523,7 +521,7 @@ class AcceleratorJobProjectService:
                         app_bucket_id,
                         uniqified_filename,
                     ) = self.get_put_create_multipart_upload_id(
-                        filename, 
+                        filename,
                         # headers=headers
                     )
 
@@ -560,7 +558,7 @@ class AcceleratorJobProjectService:
         headers = dict()
         headers["Content-Type"] = "application/octet-stream"
 
-        part_size, part_count = 50 * 1024**2, -1
+        part_size, part_count = 50 * 1024 ** 2, -1
 
         upload_id = None
         app_bucket_id = None
@@ -584,7 +582,7 @@ class AcceleratorJobProjectService:
                 )
 
                 # If part_data_size is less or equal to part_size,
-                # then we have reached last part.
+                # then we have reached the last part.
                 if len(part_data) <= part_size:
                     part_count = part_number
                     stop = True
@@ -630,12 +628,11 @@ class AcceleratorJobProjectService:
 
             raise err
 
-
     def add_filestream_as_validation_supporter(self, filename, file_stream, is_log_file=False):
         headers = dict()
         headers["Content-Type"] = "application/octet-stream"
 
-        part_size, part_count = 50 * 1024**2, -1
+        part_size, part_count = 50 * 1024 ** 2, -1
 
         upload_id = None
         app_bucket_id = None
@@ -659,7 +656,7 @@ class AcceleratorJobProjectService:
                 )
 
                 # If part_data_size is less or equal to part_size,
-                # then we have reached last part.
+                # then we have reached the last part.
                 if len(part_data) <= part_size:
                     part_count = part_number
                     stop = True
@@ -675,7 +672,7 @@ class AcceleratorJobProjectService:
                         app_bucket_id,
                         uniqified_filename,
                     ) = self.get_validator_create_multipart_upload_id(
-                        filename, 
+                        filename,
                         # headers=headers
                     )
 
@@ -717,7 +714,7 @@ class AcceleratorJobProjectService:
         headers.update(self.common_request_headers)
 
         res = self.http_client_request(
-            "POST", 
+            "POST",
             f"{self.cli_base_url}/webhook-event",
             json=dict(
                 type='STATUS_UPDATE',
@@ -728,12 +725,13 @@ class AcceleratorJobProjectService:
             headers=headers
         )
 
+
 class Fs:
     @staticmethod
     def write_stream_remote(filestream, dest_filepath, user_token, server_url):
 
         accelerator_job_service = AcceleratorJobProjectService(
-            user_token, 
+            user_token,
             server_url=server_url,
             verify_cert=(not ACCLI_DEBUG)
         )
@@ -755,9 +753,9 @@ class Fs:
 
         if not (user_token and server_url):
             raise ValueError("Remote data repository credentials not found.")
-        
+
         accelerator_job_service = AcceleratorJobProjectService(
-            user_token, 
+            user_token,
             server_url=server_url,
             verify_cert=(not ACCLI_DEBUG)
         )
@@ -765,15 +763,14 @@ class Fs:
         return accelerator_job_service.get_file_url_from_repo(
             remote_filepath
         )
-        
 
     @staticmethod
-    def write_file(source: typing.Union[str, io.BytesIO], dest_filepath):
+    def write_file(source: Union[str, io.BytesIO], dest_filepath):
         user_token = os.environ.get("ACC_JOB_TOKEN", None)
         server_url = os.environ.get("ACC_JOB_GATEWAY_SERVER", None)
 
         if isinstance(source, io.BytesIO):
-            if (user_token and server_url):
+            if user_token and server_url:
                 Fs.write_stream_remote(source, dest_filepath, user_token, server_url)
             else:
                 Fs.write_stream_local(source, dest_filepath)
@@ -785,7 +782,7 @@ class Fs:
                 raise ValueError("Source path does not exist")
 
             with open(source, 'rb') as fstream:
-                if (user_token and server_url):
+                if user_token and server_url:
                     Fs.write_stream_remote(fstream, dest_filepath, user_token, server_url)
                 else:
                     Fs.write_stream_local(fstream, dest_filepath)
@@ -797,9 +794,9 @@ class Fs:
 
         if not (user_token and server_url):
             raise ValueError("Remote data repository credentials not found.")
-        
+
         accelerator_job_service = AcceleratorJobProjectService(
-            user_token, 
+            user_token,
             server_url=server_url,
             verify_cert=(not ACCLI_DEBUG)
         )