cloudos-cli 2.69.1__tar.gz → 2.70.0__tar.gz

{cloudos_cli-2.69.1 → cloudos_cli-2.70.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: cloudos_cli
-Version: 2.69.1
+Version: 2.70.0
 Summary: Python package for interacting with CloudOS
 Home-page: https://github.com/lifebit-ai/cloudos-cli
 Author: David Piñeyro
@@ -81,6 +81,7 @@ Python package for interacting with CloudOS
       - [List Jobs](#list-jobs)
       - [Get Job Costs](#get-job-costs)
       - [Get Job Related Analyses](#get-job-related-analyses)
+      - [Delete Job Results](#delete-job-results)
     - [Bash Jobs](#bash-jobs)
       - [Send Array Job](#send-array-job)
       - [Submit a Bash Array Job](#submit-a-bash-array-job)
@@ -1378,6 +1379,79 @@ Related analyses are particularly useful for:
 > [!NOTE]
 > Related jobs are identified by their shared working directory folder ID. Only jobs within the same workspace that use the same working directory will be displayed.
 
+#### Delete Job Results
+
+CloudOS allows you to permanently delete job results directories to manage storage and clean up completed analyses. This feature provides a safe way to remove final analysis results with built-in confirmation prompts and status tracking.
+
+> [!WARNING]
+> Deleting job results is **irreversible**. All data and backups will be permanently removed and cannot be recovered. Use this feature with caution.
+
+**Delete Results with Confirmation**
+
+To delete the results directory of a completed job, use the `--delete` flag with the `job results` command. By default, a confirmation prompt will be displayed before deletion:
+
+```bash
+cloudos job results --profile my_profile --job-id 62c83a1191fe06013b7ef355 --delete
+```
+
+The expected output will show a warning confirmation:
+
+```console
+Executing results...
+Results: s3://lifebit-featured-datasets/results/62c83a1191fe06013b7ef355
+
+⚠️ Deleting final analysis results is irreversible. All data and backups will be permanently removed and cannot be recovered. You can skip this confirmation step by providing '-y' or '--yes' flag to 'cloudos job results --delete'. Please confirm that you want to delete final results of this analysis? [y/n]
+```
+
+Type `y` to proceed with deletion or `n` to cancel:
+
+```console
+y
+
+Results directories deleted successfully.
+```
+
+**Skip Confirmation Prompt**
+
+For automated workflows or when you're certain about deletion, you can skip the confirmation prompt using the `-y` or `--yes` flag:
+
+```bash
+cloudos job results --profile my_profile --job-id 62c83a1191fe06013b7ef355 --delete --yes
+```
+
+This will immediately proceed with deletion without prompting for confirmation:
+
+```console
+Executing results...
+Results: s3://lifebit-featured-datasets/results/62c83a1191fe06013b7ef355
+
+Results directories deleted successfully.
+```
+
+**Error Handling**
+
+The deletion command handles various scenarios with specific error messages:
+
+- **Job not found**: If the specified job ID doesn't exist or is not accessible
+- **No results directory**: If the job doesn't have a results directory associated with it
+- **Permission denied**: If your API key doesn't have permission to delete the results
+- **Resource conflict**: If the folder cannot be deleted due to dependencies
+
+Example when a job has no results:
+
+```bash
+cloudos job results --profile my_profile --job-id 62c83a1191fe06013b7ef355 --delete
+```
+
+```console
+Executing results...
+Selected job does not have 'Results' information.
+```
+
+> [!NOTE]
+> The `--delete` flag is compatible with other `job results` options. You can combine it with `--verbose` for detailed logging, but cannot be used together with `--link` or `--status` flags.
+
+
 ### Bash Jobs
 Execute bash scripts on CloudOS for custom processing workflows. Bash jobs allow you to run shell commands with custom parameters and are ideal for data preprocessing or simple computational tasks.
 

{cloudos_cli-2.69.1 → cloudos_cli-2.70.0}/README.md

@@ -46,6 +46,7 @@ Python package for interacting with CloudOS
       - [List Jobs](#list-jobs)
       - [Get Job Costs](#get-job-costs)
       - [Get Job Related Analyses](#get-job-related-analyses)
+      - [Delete Job Results](#delete-job-results)
     - [Bash Jobs](#bash-jobs)
       - [Send Array Job](#send-array-job)
       - [Submit a Bash Array Job](#submit-a-bash-array-job)
@@ -1343,6 +1344,79 @@ Related analyses are particularly useful for:
 > [!NOTE]
 > Related jobs are identified by their shared working directory folder ID. Only jobs within the same workspace that use the same working directory will be displayed.
 
+#### Delete Job Results
+
+CloudOS allows you to permanently delete job results directories to manage storage and clean up completed analyses. This feature provides a safe way to remove final analysis results with built-in confirmation prompts and status tracking.
+
+> [!WARNING]
+> Deleting job results is **irreversible**. All data and backups will be permanently removed and cannot be recovered. Use this feature with caution.
+
+**Delete Results with Confirmation**
+
+To delete the results directory of a completed job, use the `--delete` flag with the `job results` command. By default, a confirmation prompt will be displayed before deletion:
+
+```bash
+cloudos job results --profile my_profile --job-id 62c83a1191fe06013b7ef355 --delete
+```
+
+The expected output will show a warning confirmation:
+
+```console
+Executing results...
+Results: s3://lifebit-featured-datasets/results/62c83a1191fe06013b7ef355
+
+⚠️ Deleting final analysis results is irreversible. All data and backups will be permanently removed and cannot be recovered. You can skip this confirmation step by providing '-y' or '--yes' flag to 'cloudos job results --delete'. Please confirm that you want to delete final results of this analysis? [y/n]
+```
+
+Type `y` to proceed with deletion or `n` to cancel:
+
+```console
+y
+
+Results directories deleted successfully.
+```
+
+**Skip Confirmation Prompt**
+
+For automated workflows or when you're certain about deletion, you can skip the confirmation prompt using the `-y` or `--yes` flag:
+
+```bash
+cloudos job results --profile my_profile --job-id 62c83a1191fe06013b7ef355 --delete --yes
+```
+
+This will immediately proceed with deletion without prompting for confirmation:
+
+```console
+Executing results...
+Results: s3://lifebit-featured-datasets/results/62c83a1191fe06013b7ef355
+
+Results directories deleted successfully.
+```
+
+**Error Handling**
+
+The deletion command handles various scenarios with specific error messages:
+
+- **Job not found**: If the specified job ID doesn't exist or is not accessible
+- **No results directory**: If the job doesn't have a results directory associated with it
+- **Permission denied**: If your API key doesn't have permission to delete the results
+- **Resource conflict**: If the folder cannot be deleted due to dependencies
+
+Example when a job has no results:
+
+```bash
+cloudos job results --profile my_profile --job-id 62c83a1191fe06013b7ef355 --delete
+```
+
+```console
+Executing results...
+Selected job does not have 'Results' information.
+```
+
+> [!NOTE]
+> The `--delete` flag is compatible with other `job results` options. You can combine it with `--verbose` for detailed logging, but cannot be used together with `--link` or `--status` flags.
+
+
 ### Bash Jobs
 Execute bash scripts on CloudOS for custom processing workflows. Bash jobs allow you to run shell commands with custom parameters and are ideal for data preprocessing or simple computational tasks.
 

{cloudos_cli-2.69.1 → cloudos_cli-2.70.0}/cloudos_cli/__main__.py

@@ -31,6 +31,7 @@ from cloudos_cli.configure.configure import (
     CLOUDOS_URL
 )
 from cloudos_cli.related_analyses.related_analyses import related_analyses
+from cloudos_cli.delete.results import delete_job_results
 
 
 # GLOBAL VARS
@@ -1013,6 +1014,12 @@ def job_logs(ctx,
 @click.option('--link',
               help='Link the results directories to an interactive session.',
               is_flag=True)
+@click.option('--delete',
+              help='Delete the results directory of a CloudOS job.',
+              is_flag=True)
+@click.option('-y', '--yes',
+              help='Skip confirmation prompt when deleting results.',
+              is_flag=True)
 @click.option('--session-id',
               help='The specific CloudOS interactive session id. Required when using --link flag.',
               required=False)
@@ -1037,6 +1044,8 @@ def job_results(ctx,
                 workspace_id,
                 job_id,
                 link,
+                delete,
+                yes,
                 session_id,
                 status,
                 verbose,
@@ -1150,12 +1159,12 @@ def job_results(ctx,
         results = cl.get_job_results(job_id, workspace_id, verify_ssl)
         for name, path in results.items():
             print(f"{name}: {path}")
-        
+
         # Link to interactive session if requested
         if link:
             if verbose:
                 print(f'\tLinking {len(results)} result directories to interactive session {session_id}...')
-            
+
             # Use Link class to perform the linking
             link_client = Link(
                 cloudos_url=cloudos_url,
@@ -1165,12 +1174,35 @@ def job_results(ctx,
                 project_name=None,  # Not needed for S3 paths
                 verify=verify_ssl
             )
-            
+
             for name, path in results.items():
                 if verbose:
                     print(f'\t\tLinking {name} ({path})...')
                 link_client.link_folder(path, session_id)
-            
+
+        # Delete results directory if requested
+        if delete:
+            # Ask for confirmation unless --yes flag is provided
+            if not yes:
+                confirmation_message = (
+                    "\n⚠️ Deleting final analysis results is irreversible. "
+                    "All data and backups will be permanently removed and cannot be recovered. "
+                    "You can skip this confirmation step by providing '-y' or '--yes' flag to "
+                    "'cloudos job results --delete'. "
+                    "Please confirm that you want to delete final results of this analysis? [y/n] "
+                )
+                click.secho(confirmation_message, fg='white', bg='yellow')
+                user_input = input().strip().lower()
+                if user_input != 'y':
+                    print('\nDeletion cancelled.')
+                    return
+            if verbose:
+                print(f'\nDeleting {len(results)} result directories from CloudOS...')
+            delete_job_results(cloudos_url, apikey, job_id, workspace_id, verify_ssl)
+            print('Results directories deleted successfully.')
+        else:
+            if yes:
+                click.secho("\n'--yes' flag is ignored when '--delete' is not specified.", fg='yellow', bold=True)
     except BadRequestException as e:
         raise ValueError(f"Job '{job_id}' not found or not accessible: {str(e)}")
     except Exception as e:

cloudos_cli-2.70.0/cloudos_cli/_version.py

@@ -0,0 +1 @@
+__version__ = '2.70.0'

cloudos_cli-2.70.0/cloudos_cli/delete/__init__.py

@@ -0,0 +1,8 @@
+"""
+Functions and classes related to delete (results & workdir).
+"""
+
+from .results import delete_job_results
+
+
+__all__ = ['results']

cloudos_cli-2.70.0/cloudos_cli/delete/results.py

@@ -0,0 +1,24 @@
+import click
+import cloudos_cli.jobs.job as jb
+
+
+def delete_job_results(cloudos_url, apikey, j_id, workspace_id, verify=True):
+    job = jb.Job(cloudos_url, apikey, None, workspace_id, None, None, workflow_id=1234, project_id="None",
+                 mainfile=None, importsfile=None, verify=verify)
+
+    # Get job results directory
+    try:
+        j_results_dir = job.get_field_from_jobs_endpoint(j_id, field='analysisResults', verify=verify)
+    except Exception as e:
+        if "Field 'analysisResults' not found in endpoint 'jobs'" in str(e):
+            click.secho("Selected job does not have 'Results' information.", fg="yellow", bold=True)
+            return
+        else:
+            raise e
+
+    # Get folder ID
+    folder_id = j_results_dir.get('folderId')
+    if not folder_id:
+        raise ValueError("The job does not have a results directory associated.")
+
+    job.delete_job_results(folder_id, verify=verify)

{cloudos_cli-2.69.1 → cloudos_cli-2.70.0}/cloudos_cli/jobs/job.py

@@ -7,7 +7,7 @@ from typing import Union
 import json
 from cloudos_cli.clos import Cloudos
 from cloudos_cli.utils.errors import BadRequestException
-from cloudos_cli.utils.requests import retry_requests_post, retry_requests_get
+from cloudos_cli.utils.requests import retry_requests_post, retry_requests_get, retry_requests_delete
 from pathlib import Path
 import base64
 from cloudos_cli.utils.array_job import classify_pattern, get_file_or_folder_id, extract_project
@@ -1426,4 +1426,59 @@ class Job(Cloudos):
         if not parent_job_id:
             return None
         else:
-            return parent_job_id
+            return parent_job_id
+
+    def delete_job_results(self, folder_id, verify=True):
+        """Delete job results folder.
+
+        Parameters
+        ----------
+        folder_id : str
+            The ID of the folder to delete (typically a job results folder).
+        verify : [bool | str], optional
+            Whether to use SSL verification or not. Alternatively, if
+            a string is passed, it will be interpreted as the path to
+            the SSL certificate file. Default is True.
+
+        Returns
+        -------
+        dict
+            A dictionary containing the deletion response from the API.
+
+        Raises
+        ------
+        BadRequestException
+            If the request fails with a status code indicating an error.
+        ValueError
+            If the folder ID is invalid or the folder does not exist.
+        """
+        headers = {
+            "Content-type": "application/json",
+            "apikey": self.apikey
+        }
+        url = f"{self.cloudos_url}/api/v1/folders/{folder_id}?teamId={self.workspace_id}"
+        response = retry_requests_delete(url, headers=headers, verify=verify)
+
+        # Handle specific status codes according to API specification
+        if response.status_code == 204:
+            # NoContent - successful deletion
+            return {"message": "Results deleted successfully", "status": "deleted"}
+        elif response.status_code == 400:
+            raise ValueError("Operation not permitted: Workspace does not allow deleting results folders.")
+        elif response.status_code == 401:
+            raise ValueError("Unauthorized: Invalid or missing API key.")
+        elif response.status_code == 403:
+            raise ValueError("Forbidden: You don't have permission to delete this folder.")
+        elif response.status_code == 404:
+            raise ValueError(f"{json.loads(response.content)['message']}")
+        elif response.status_code == 409:
+            raise ValueError("Conflict: The folder cannot be deleted due to a conflict (e.g., folder is not empty or has dependencies).")
+        elif response.status_code == 500:
+            raise ValueError("Internal server error: The server encountered an error while processing the deletion request.")
+        elif response.status_code >= 400:
+            raise BadRequestException(response)
+
+        # For any other successful response, parse content if available
+        if response.content:
+            return json.loads(response.content)
+        return {"message": "Results deleted successfully"}

{cloudos_cli-2.69.1 → cloudos_cli-2.70.0}/cloudos_cli.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: cloudos_cli
-Version: 2.69.1
+Version: 2.70.0
 Summary: Python package for interacting with CloudOS
 Home-page: https://github.com/lifebit-ai/cloudos-cli
 Author: David Piñeyro
@@ -81,6 +81,7 @@ Python package for interacting with CloudOS
       - [List Jobs](#list-jobs)
       - [Get Job Costs](#get-job-costs)
       - [Get Job Related Analyses](#get-job-related-analyses)
+      - [Delete Job Results](#delete-job-results)
     - [Bash Jobs](#bash-jobs)
       - [Send Array Job](#send-array-job)
       - [Submit a Bash Array Job](#submit-a-bash-array-job)
@@ -1378,6 +1379,79 @@ Related analyses are particularly useful for:
 > [!NOTE]
 > Related jobs are identified by their shared working directory folder ID. Only jobs within the same workspace that use the same working directory will be displayed.
 
+#### Delete Job Results
+
+CloudOS allows you to permanently delete job results directories to manage storage and clean up completed analyses. This feature provides a safe way to remove final analysis results with built-in confirmation prompts and status tracking.
+
+> [!WARNING]
+> Deleting job results is **irreversible**. All data and backups will be permanently removed and cannot be recovered. Use this feature with caution.
+
+**Delete Results with Confirmation**
+
+To delete the results directory of a completed job, use the `--delete` flag with the `job results` command. By default, a confirmation prompt will be displayed before deletion:
+
+```bash
+cloudos job results --profile my_profile --job-id 62c83a1191fe06013b7ef355 --delete
+```
+
+The expected output will show a warning confirmation:
+
+```console
+Executing results...
+Results: s3://lifebit-featured-datasets/results/62c83a1191fe06013b7ef355
+
+⚠️ Deleting final analysis results is irreversible. All data and backups will be permanently removed and cannot be recovered. You can skip this confirmation step by providing '-y' or '--yes' flag to 'cloudos job results --delete'. Please confirm that you want to delete final results of this analysis? [y/n]
+```
+
+Type `y` to proceed with deletion or `n` to cancel:
+
+```console
+y
+
+Results directories deleted successfully.
+```
+
+**Skip Confirmation Prompt**
+
+For automated workflows or when you're certain about deletion, you can skip the confirmation prompt using the `-y` or `--yes` flag:
+
+```bash
+cloudos job results --profile my_profile --job-id 62c83a1191fe06013b7ef355 --delete --yes
+```
+
+This will immediately proceed with deletion without prompting for confirmation:
+
+```console
+Executing results...
+Results: s3://lifebit-featured-datasets/results/62c83a1191fe06013b7ef355
+
+Results directories deleted successfully.
+```
+
+**Error Handling**
+
+The deletion command handles various scenarios with specific error messages:
+
+- **Job not found**: If the specified job ID doesn't exist or is not accessible
+- **No results directory**: If the job doesn't have a results directory associated with it
+- **Permission denied**: If your API key doesn't have permission to delete the results
+- **Resource conflict**: If the folder cannot be deleted due to dependencies
+
+Example when a job has no results:
+
+```bash
+cloudos job results --profile my_profile --job-id 62c83a1191fe06013b7ef355 --delete
+```
+
+```console
+Executing results...
+Selected job does not have 'Results' information.
+```
+
+> [!NOTE]
+> The `--delete` flag is compatible with other `job results` options. You can combine it with `--verbose` for detailed logging, but cannot be used together with `--link` or `--status` flags.
+
+
 ### Bash Jobs
 Execute bash scripts on CloudOS for custom processing workflows. Bash jobs allow you to run shell commands with custom parameters and are ideal for data preprocessing or simple computational tasks.
 

{cloudos_cli-2.69.1 → cloudos_cli-2.70.0}/cloudos_cli.egg-info/SOURCES.txt

@@ -17,6 +17,8 @@ cloudos_cli/cost/__init__.py
 cloudos_cli/cost/cost.py
 cloudos_cli/datasets/__init__.py
 cloudos_cli/datasets/datasets.py
+cloudos_cli/delete/__init__.py
+cloudos_cli/delete/results.py
 cloudos_cli/import_wf/__init__.py
 cloudos_cli/import_wf/import_wf.py
 cloudos_cli/jobs/__init__.py

cloudos_cli-2.69.1/cloudos_cli/_version.py

@@ -1 +0,0 @@
-__version__ = '2.69.1'