accli 0.5.7__tar.gz → 0.6.1__tar.gz

{accli-0.5.7 → accli-0.6.1}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: accli
-Version: 0.5.7
+Version: 0.6.1
 Summary: IIASA Accelerator Client
 Author-email: Wrufesh S <wrufesh@gmail.com>
 License: The MIT License (MIT)
@@ -33,8 +33,16 @@ Requires-Python: >=3.7.17
 Description-Content-Type: text/markdown
 License-File: LICENSE
 
-# Accelerator terminal CLI and python API
+# Accelerator terminal client and Python API
 
+Provides a command-line client for interacting with the Accelerator as well as a Python API in the form of the `accli` package. These communicate with the rest API of the Accelerator [Control Services Backend](https://github.com/iiasa/control_services_backend).
+
+Uses device authentication:
+- Part 0Auth: [Device Authentication Flow](https://auth0.com/docs/get-started/authentication-and-authorization-flow/device-authorization-flow).
+- Auth valid for 7 days.
+- Grants are limited.
+- Access via RBAC:
+  * Stateless tokens.
 
 ## User Guide
 

{accli-0.5.7 → accli-0.6.1}/README.md

@@ -1,5 +1,13 @@
-# Accelerator terminal CLI and python API
+# Accelerator terminal client and Python API
 
+Provides a command-line client for interacting with the Accelerator as well as a Python API in the form of the `accli` package. These communicate with the rest API of the Accelerator [Control Services Backend](https://github.com/iiasa/control_services_backend).
+
+Uses device authentication:
+- Part 0Auth: [Device Authentication Flow](https://auth0.com/docs/get-started/authentication-and-authorization-flow/device-authorization-flow).
+- Auth valid for 7 days.
+- Grants are limited.
+- Access via RBAC:
+  * Stateless tokens.
 
 ## User Guide
 

{accli-0.5.7 → accli-0.6.1}/accli/AcceleratorJobProjectService.py

@@ -82,6 +82,22 @@ class AcceleratorJobProjectService:
         )
         return todict(res.data)
     
+    
+    def enumerate_files_by_prefix(self, prefix):
+        project_slug = filename.split('/')[0]
+
+
+        b64_encoded_prefix = base64.b64encode(prefix.encode()).decode()
+
+        res = self.http_client_request(
+            "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(
@@ -633,3 +649,21 @@ class Fs:
                     Fs.write_stream_remote(fstream, dest_filepath, user_token, server_url)
                 else:
                     Fs.write_stream_local(fstream, dest_filepath)
+
+    @staticmethod
+    def enumerate_files_by_prefix(prefix):
+        user_token = os.environ.get("ACC_JOB_TOKEN", None)
+        server_url = os.environ.get("ACC_JOB_GATEWAY_SERVER", None)
+
+        if not (user_token and server_url):
+            raise ValueError("Remote data repository credentials not found.")
+        
+        accelerator_job_service = AcceleratorJobProjectService(
+            user_token, 
+            server_url=server_url,
+            verify_cert=True
+        )
+
+        return accelerator_job_service.enumerate_files_by_prefix(
+            prefix
+        )

{accli-0.5.7 → accli-0.6.1}/accli/AcceleratorTaskDispatcher.py

@@ -8,7 +8,11 @@ import requests
 from typing import Optional, List, Dict
 from pydantic.v1 import BaseModel, root_validator
 from accli.AcceleratorTerminalCliProjectService import AcceleratorTerminalCliProjectService
-from accli.token import get_github_app_token, get_token, get_server_url, get_project_slug
+from accli.token import (
+    get_github_app_token, 
+    get_token, get_server_url, 
+    get_project_slug
+)
 
 FOLDER_JOB_REPO_URL = 'https://github.com/IIASA-Accelerator/wkube-job.git'
 
@@ -74,6 +78,9 @@ def push_folder_job(dir):
 
     copy_tree(dir, repo_dir)
 
+    if os.path.isfile(f'{repo_dir}/wkube.py'):
+        os.remove(f'{repo_dir}/wkube.py')
+
     temp_zip_path = f"{repo_dir}/temp.zip"
 
     compress_folder(repo_dir, temp_zip_path)
@@ -106,7 +113,9 @@ def push_folder_job(dir):
 
 
 class JobDispatchModel(BaseModel):
-    is_holder_job: bool = True  
+    is_holder_job: bool = True
+
+    name: str
     
     execute_cluster: str
     job_location: str
@@ -150,7 +159,7 @@ class WKubeTaskMeta(BaseModel):
 class WKubeTaskKwargs(BaseModel):
     docker_image: Optional[str]
 
-    job_folder: Optional[str]
+    job_folder: str = './'
     
     repo_url: Optional[str]                # required when docker image is not present
     repo_branch: Optional[str]             # required when docker image is not present
@@ -176,21 +185,21 @@ class WKubeTaskKwargs(BaseModel):
     def validate_root(cls, values):
         if not values.get('docker_image'):
 
-            job_folder = values.get('job_folder')
+            job_folder = values.get('job_folder', './')
 
-            if not job_folder: 
-            
+            if not (values.get('repo_url') and values.get('repo_branch')):
+                    remote_url, branch_name = push_folder_job(job_folder)
+                    values['repo_url'] = remote_url
+                    values['repo_branch'] = branch_name
+            else:
                 if not values.get('repo_url'): 
                     # TODO if has no repo url just set it
                     raise ValueError("repo_url is required")
                 
                 if not values.get('repo_branch'):
                     raise ValueError('repo_branch is required')
-            else: 
-                remote_url, branch_name = push_folder_job(job_folder)
-                values['repo_url'] = remote_url
-                values['repo_branch'] = branch_name
 
+            
             if not values.get('docker_filename'):
                 if not values.get("base_stack"):
                     raise ValueError("base_stack is required when dockerfile is not defined")
@@ -226,13 +235,14 @@ class WKubeTask(GenericTask):
         wkube_task_meta = dict()
 
         if (t_args or t_kwargs):
-            
+            name = t_kwargs.pop('name')        
             WKubeTaskPydantic(*t_args, **t_kwargs)
             wkube_task_kwargs = WKubeTaskKwargs(*t_args, **t_kwargs)
             wkube_task_meta.update(WKubeTaskMeta(*t_args, **t_kwargs).dict(exclude_unset=True))
             
 
         self.dispatch_model_task = JobDispatchModel(
+            name=name,
             is_holder_job=not (t_args or t_kwargs),
             execute_cluster='WKUBE',
             job_location='acc_native_jobs.dispatch_wkube_task',

{accli-0.5.7 → accli-0.6.1}/accli/_version.py

@@ -1,3 +1,3 @@
 # Please strictly put double quote to use this info for git tag 
 # Read developer guide for git tag command with regex
-VERSION = "v0.5.7" 
+VERSION = "v0.6.1" 

{accli-0.5.7 → accli-0.6.1}/accli/cli.py

@@ -47,8 +47,8 @@ def about():
 
 @app.command()
 def login(
-    server: Annotated[str, typer.Option(help="Accelerator server url.")] = "https://accelerator-api.iiasa.ac.at", 
-    webcli: Annotated[str, typer.Option(help="Accelerator web client for authorization.")] = "https://accelerator.iiasa.ac.at"
+    server: Annotated[str, typer.Option(..., '-c',help="Accelerator server url.")] = "https://accelerator-api.iiasa.ac.at", 
+    webcli: Annotated[str, typer.Option(..., '-s', help="Accelerator web client for authorization.")] = "https://accelerator.iiasa.ac.at"
 ):
     print(
         f"[bold cyan]Welcome to Accelerator Terminal Client.[/bold cyan]\n"
@@ -100,7 +100,7 @@ def upload(
     project_slug: Annotated[str, typer.Argument(help="Unique Accelerator project slug.")],
     path: Annotated[str, typer.Argument(help="Folder path to upload to Accelerator project space.")],
     folder_name: Annotated[str, typer.Argument(help="Name of the folder to be made in Accelerator project space.")],
-    max_workers: Annotated[int, typer.Option(help="Maximum worker pool for multipart upload.")] = os.cpu_count()
+    max_workers: Annotated[int, typer.Option(..., '-w',help="Maximum worker pool for multipart upload.")] = os.cpu_count()
 ):
 
 
@@ -154,7 +154,7 @@ def validate(
     project_slug: Annotated[str, typer.Argument(help="Unique Accelerator project slug.")],
     template_slug: Annotated[str, typer.Argument(help="Unique project template slug")],
     filepath: Annotated[str, typer.Argument(help="Path of the file to validate")],
-    server: Annotated[str, typer.Option(help="Accelerator server url.")] = "https://accelerator-api.iiasa.ac.at",
+    server: Annotated[str, typer.Option(..., '-s',help="Accelerator server url.")] = "https://accelerator-api.iiasa.ac.at",
 ):
     
 
@@ -176,14 +176,12 @@ def validate(
 @app.command()
 def dispatch(
     project_slug: Annotated[str, typer.Argument(help="Unique Accelerator project slug.")],
-    # experiment_name: Annotated[str, typer.Argument(help="Experiment or simulation name. Please put name in quote it includes space(s).")],
-    workflow_file: Annotated[str, typer.Argument(help="Python workflow filepath.")],
     root_task_variable: Annotated[str, typer.Argument(help="Root task variable in workflow_file.")],
-    server: Annotated[str, typer.Option(help="Accelerator server url.")] = "https://accelerator-api.iiasa.ac.at",
+    server: Annotated[str, typer.Option(..., '-s', help="Accelerator server url.")] = "https://accelerator-api.iiasa.ac.at",
+    workflow_filename: Annotated[str, typer.Option(..., '-f', help="Python workflow filepath.")] = "wkube.py"
 ):
     set_project_slug(project_slug)
     access_token = get_token()
-
     server_url = get_server_url()
 
     term_cli_project_service = AcceleratorTerminalCliProjectService(
@@ -192,7 +190,14 @@ def dispatch(
         verify_cert=False
     )
 
-    spec = importlib.util.spec_from_file_location("workflow", workflow_file)
+    base_dir = os.getcwd()
+    
+    if base_dir.endswith('/'):
+        workflow_filepath = f"{base_dir}{workflow_filename}"
+    else:
+        workflow_filepath = f"{base_dir}/{workflow_filename}"
+
+    spec = importlib.util.spec_from_file_location("workflow", workflow_filepath)
 
     module = importlib.util.module_from_spec(spec)
 

{accli-0.5.7 → accli-0.6.1}/accli.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: accli
-Version: 0.5.7
+Version: 0.6.1
 Summary: IIASA Accelerator Client
 Author-email: Wrufesh S <wrufesh@gmail.com>
 License: The MIT License (MIT)
@@ -33,8 +33,16 @@ Requires-Python: >=3.7.17
 Description-Content-Type: text/markdown
 License-File: LICENSE
 
-# Accelerator terminal CLI and python API
+# Accelerator terminal client and Python API
 
+Provides a command-line client for interacting with the Accelerator as well as a Python API in the form of the `accli` package. These communicate with the rest API of the Accelerator [Control Services Backend](https://github.com/iiasa/control_services_backend).
+
+Uses device authentication:
+- Part 0Auth: [Device Authentication Flow](https://auth0.com/docs/get-started/authentication-and-authorization-flow/device-authorization-flow).
+- Auth valid for 7 days.
+- Grants are limited.
+- Access via RBAC:
+  * Stateless tokens.
 
 ## User Guide