cloudos-cli 2.35.0__tar.gz → 2.36.0__tar.gz

{cloudos_cli-2.35.0 → cloudos_cli-2.36.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: cloudos_cli
-Version: 2.35.0
+Version: 2.36.0
 Summary: Python package for interacting with CloudOS
 Home-page: https://github.com/lifebit-ai/cloudos-cli
 Author: David Piñeyro
@@ -1013,6 +1013,38 @@ Please, note that in the above example a preconfigured profile has been used. If
     --workspace-id $WORKSPACE_ID \
     --project-name $PROJEC_NAME
 ```
+
+#### Copying files and folders
+
+Files and folders can be copied **from** anywhere in the project **to** `Data` or any of its subfolders programmatically (i.e `Data`, `Data/folder/file.txt`).
+
+1. The copy can happen **within the same project** running the following command:
+```
+cloudos datasets cp <souce_path> <destination_path> --profile <profile name>
+```
+where the source project as well as the destination one is the one defined in the profile.
+
+2. The move can also happen **across different projects**  within the same workspace by running the following command
+```
+cloudos datasets cp <source_path> <destiantion_path> --profile <profile_name> --destination-project-name <project_name>
+```
+In this case, only the source project is the one specified in the profile.
+
+Any of the `source_path` must be a full path; any `destination_path` must be a path starting with `Data` and finishing with the folder where to move the file/folder. An example of such command is:
+
+```
+cloudos datasets cp AnalysesResults/my_analysis/results/my_plot.png Data/plots 
+```
+
+Please, note that in the above example a preconfigured profile has been used. If no profile is provided and there is no default profile, the user will need to also provide the following flags
+```bash
+    --cloudos-url $CLOUDOS \
+    --apikey $MY_API_KEY \
+    --workspace-id $WORKSPACE_ID \
+    --project-name $PROJEC_NAME
+```
+
+
 #### Create a (virtual) folder
 
 New folders can be created within the `Data` dataset and its subfolders using the following command
@@ -1032,30 +1064,21 @@ Please, note that in the above example a preconfigured profile has been used. If
     --workspace-id $WORKSPACE_ID \
     --project-name $PROJEC_NAME
 ```
+#### Removing files and folders
 
-#### Copying files and folders
-
-Files and folders can be copied **from** anywhere in the project **to** `Data` or any of its subfolders programmatically (i.e `Data`, `Data/folder/file.txt`).
-
-1. The copy can happen **within the same project** running the following command:
-```
-cloudos datasets cp <souce_path> <destination_path> --profile <profile name>
-```
-where the source project as well as the destination one is the one defined in the profile.
+Files and folders can be removed from file explorer (in the `Data` datasets and its subfolders) using the following command
 
-2. The move can also happen **across different projects**  within the same workspace by running the following command
 ```
-cloudos datasets cp <source_path> <destiantion_path> --profile <profile_name> --destination-project-name <project_name>
+cloudos datasets rm <path> 
 ```
-In this case, only the source project is the one specified in the profile.
+where `path` is the full path to the file/folder to be removed.
 
-Any of the `source_path` must be a full path; any `destination_path` must be a path starting with `Data` and finishing with the folder where to move the file/folder. An example of such command is:
+Please, be aware that removing files and folders will only remove them from the file explorer and not from the corresponding cloud storage.
 
-```
-cloudos datasets cp AnalysesResults/my_analysis/results/my_plot.png Data/plots 
-```
+Please, keep in mind that you are only allowed to remove files or folders in `Data` or its subfolders.
 
 Please, note that in the above example a preconfigured profile has been used. If no profile is provided and there is no default profile, the user will need to also provide the following flags
+
 ```bash
     --cloudos-url $CLOUDOS \
     --apikey $MY_API_KEY \

{cloudos_cli-2.35.0 → cloudos_cli-2.36.0}/README.md

@@ -978,6 +978,38 @@ Please, note that in the above example a preconfigured profile has been used. If
     --workspace-id $WORKSPACE_ID \
     --project-name $PROJEC_NAME
 ```
+
+#### Copying files and folders
+
+Files and folders can be copied **from** anywhere in the project **to** `Data` or any of its subfolders programmatically (i.e `Data`, `Data/folder/file.txt`).
+
+1. The copy can happen **within the same project** running the following command:
+```
+cloudos datasets cp <souce_path> <destination_path> --profile <profile name>
+```
+where the source project as well as the destination one is the one defined in the profile.
+
+2. The move can also happen **across different projects**  within the same workspace by running the following command
+```
+cloudos datasets cp <source_path> <destiantion_path> --profile <profile_name> --destination-project-name <project_name>
+```
+In this case, only the source project is the one specified in the profile.
+
+Any of the `source_path` must be a full path; any `destination_path` must be a path starting with `Data` and finishing with the folder where to move the file/folder. An example of such command is:
+
+```
+cloudos datasets cp AnalysesResults/my_analysis/results/my_plot.png Data/plots 
+```
+
+Please, note that in the above example a preconfigured profile has been used. If no profile is provided and there is no default profile, the user will need to also provide the following flags
+```bash
+    --cloudos-url $CLOUDOS \
+    --apikey $MY_API_KEY \
+    --workspace-id $WORKSPACE_ID \
+    --project-name $PROJEC_NAME
+```
+
+
 #### Create a (virtual) folder
 
 New folders can be created within the `Data` dataset and its subfolders using the following command
@@ -997,30 +1029,21 @@ Please, note that in the above example a preconfigured profile has been used. If
     --workspace-id $WORKSPACE_ID \
     --project-name $PROJEC_NAME
 ```
+#### Removing files and folders
 
-#### Copying files and folders
-
-Files and folders can be copied **from** anywhere in the project **to** `Data` or any of its subfolders programmatically (i.e `Data`, `Data/folder/file.txt`).
-
-1. The copy can happen **within the same project** running the following command:
-```
-cloudos datasets cp <souce_path> <destination_path> --profile <profile name>
-```
-where the source project as well as the destination one is the one defined in the profile.
+Files and folders can be removed from file explorer (in the `Data` datasets and its subfolders) using the following command
 
-2. The move can also happen **across different projects**  within the same workspace by running the following command
 ```
-cloudos datasets cp <source_path> <destiantion_path> --profile <profile_name> --destination-project-name <project_name>
+cloudos datasets rm <path> 
 ```
-In this case, only the source project is the one specified in the profile.
+where `path` is the full path to the file/folder to be removed.
 
-Any of the `source_path` must be a full path; any `destination_path` must be a path starting with `Data` and finishing with the folder where to move the file/folder. An example of such command is:
+Please, be aware that removing files and folders will only remove them from the file explorer and not from the corresponding cloud storage.
 
-```
-cloudos datasets cp AnalysesResults/my_analysis/results/my_plot.png Data/plots 
-```
+Please, keep in mind that you are only allowed to remove files or folders in `Data` or its subfolders.
 
 Please, note that in the above example a preconfigured profile has been used. If no profile is provided and there is no default profile, the user will need to also provide the following flags
+
 ```bash
     --cloudos-url $CLOUDOS \
     --apikey $MY_API_KEY \

{cloudos_cli-2.35.0 → cloudos_cli-2.36.0}/cloudos_cli/__main__.py

@@ -90,7 +90,8 @@ def run_cloudos_cli(ctx):
                 'mv': shared_config,
                 'rename': shared_config,
                 'cp': shared_config,
-                'mkdir': shared_config
+                'mkdir': shared_config,
+                'rm': shared_config
             }
         })
     else:
@@ -139,7 +140,8 @@ def run_cloudos_cli(ctx):
                 'mv': shared_config,
                 'rename': shared_config,
                 'cp': shared_config,
-                'mkdir': shared_config
+                'mkdir': shared_config,
+                'rm': shared_config
             }
         })
 
@@ -3044,7 +3046,7 @@ def copy_item_cli(ctx, source_path, destination_path, apikey, cloudos_url,
         sys.exit(1)
     # Find the source item
     source_item = None
-    for item in source_content.get('files' or 'folders', {}):
+    for item in source_content.get('files', []) + source_content.get('folders', []):
         if item.get("name") == source_name:
             source_item = item
             break
@@ -3206,5 +3208,104 @@ def mkdir_item(ctx, new_folder_path, apikey, cloudos_url,
         sys.exit(1)
 
 
+@datasets.command(name="rm")
+@click.argument("target_path", required=True)
+@click.option('-k', '--apikey', required=True, help='Your CloudOS API key.')
+@click.option('-c', '--cloudos-url', default=CLOUDOS_URL, required=True, help='The CloudOS URL.')
+@click.option('--workspace-id', required=True, help='The CloudOS workspace ID.')
+@click.option('--project-name', required=True, help='The project name.')
+@click.option('--disable-ssl-verification', is_flag=True, help='Disable SSL certificate verification.')
+@click.option('--ssl-cert', help='Path to your SSL certificate file.')
+@click.option('--profile', default=None, help='Profile to use from the config file.')
+@click.pass_context
+def rm_item(ctx, target_path, apikey, cloudos_url,
+            workspace_id, project_name,
+            disable_ssl_verification, ssl_cert, profile):
+    """
+    Delete a file or folder in a CloudOS project.
+
+    TARGET_PATH [path]: the full path to the file or folder to delete. Must start with 'Data'. \n
+    E.g.: 'Data/folderA/file.txt' or 'Data/my_analysis/results/folderB'
+    """
+    if not target_path.strip("/").startswith("Data/"):
+        click.echo("[ERROR] TARGET_PATH must start with 'Data/', pointing to a file or folder.", err=True)
+        sys.exit(1)
+    click.echo("Loading configuration profile...")
+    config_manager = ConfigurationProfile()
+    required_dict = {
+        'apikey': True,
+        'workspace_id': True,
+        'workflow_name': False,
+        'project_name': True
+    }
+
+    apikey, cloudos_url, workspace_id, workflow_name, repository_platform, execution_platform, project_name = (
+        config_manager.load_profile_and_validate_data(
+            ctx,
+            INIT_PROFILE,
+            CLOUDOS_URL,
+            profile=profile,
+            required_dict=required_dict,
+            apikey=apikey,
+            cloudos_url=cloudos_url,
+            workspace_id=workspace_id,
+            workflow_name=None,
+            repository_platform=None,
+            execution_platform=None,
+            project_name=project_name
+        )
+    )
+
+    verify_ssl = ssl_selector(disable_ssl_verification, ssl_cert)
+
+    client = Datasets(
+        cloudos_url=cloudos_url,
+        apikey=apikey,
+        workspace_id=workspace_id,
+        project_name=project_name,
+        verify=verify_ssl,
+        cromwell_token=None
+    )
+
+    parts = target_path.strip("/").split("/")
+    parent_path = "/".join(parts[:-1])
+    item_name = parts[-1]
+
+    try:
+        contents = client.list_folder_content(parent_path)
+    except Exception as e:
+        click.echo(f"[ERROR] Could not list contents at '{parent_path or '[project root]'}': {str(e)}", err=True)
+        sys.exit(1)
+
+    found_item = None
+    for item in contents.get('files', []) + contents.get('folders', []):
+        if item.get("name") == item_name:
+            found_item = item
+            break
+
+    if not found_item:
+        click.echo(f"[ERROR] Item '{item_name}' not found in '{parent_path or '[project root]'}'", err=True)
+        sys.exit(1)
+
+    item_id = found_item["_id"]
+    kind = "Folder" if "folderType" in found_item else "File"
+
+    click.echo(f"Deleting {kind} '{item_name}' from '{parent_path or '[root]'}'...")
+    try:
+        response = client.delete_item(item_id=item_id, kind=kind)
+        if response.ok:
+            click.secho(
+                f"[SUCCESS] {kind} '{item_name}' was deleted from '{parent_path or '[root]'}'.",
+                fg="green", bold=True
+            )
+            click.secho("This item will still be available on your Cloud Provider.", fg="yellow")
+        else:
+            click.echo(f"[ERROR] Deletion failed: {response.status_code} - {response.text}", err=True)
+            sys.exit(1)
+    except Exception as e:
+        click.echo(f"[ERROR] Delete operation failed: {str(e)}", err=True)
+        sys.exit(1)
+
+
 if __name__ == "__main__":
     run_cloudos_cli()

cloudos_cli-2.36.0/cloudos_cli/_version.py

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

{cloudos_cli-2.35.0 → cloudos_cli-2.36.0}/cloudos_cli/datasets/datasets.py

@@ -5,7 +5,7 @@ This is the main class for file explorer (datasets).
 from dataclasses import dataclass
 from typing import Union
 from cloudos_cli.clos import Cloudos
-from cloudos_cli.utils.requests import retry_requests_get, retry_requests_put, retry_requests_post
+from cloudos_cli.utils.requests import retry_requests_get, retry_requests_put, retry_requests_post, retry_requests_delete
 import json
 
 @dataclass
@@ -237,7 +237,7 @@ class Datasets(Cloudos):
             else:
                 item["s3Prefix"] = item['path']
                 item["s3BucketName"] = s3_bucket_name
-
+                item["fileType"] = "S3File"
                 normalized["files"].append(item)
 
         return normalized
@@ -436,7 +436,7 @@ class Datasets(Cloudos):
         elif item.get("fileType") == "S3File":
             payload = {
                 "s3BucketName": item["s3BucketName"],
-                "s3ObjectKey": item["s3ObjectKey"],
+                "s3ObjectKey": item.get("s3ObjectKey") or item.get("s3Prefix"),
                 "name": item["name"],
                 "parent": parent,
                 "isManagedByLifebit": item.get("isManagedByLifebit", False),
@@ -487,4 +487,34 @@ class Datasets(Cloudos):
         }
 
         response = retry_requests_post(url, headers=headers, json=payload, verify=self.verify)
+        return response
+    
+    def delete_item(self, item_id: str, kind: str):
+        """
+        Delete a file or folder in CloudOS.
+
+        Parameters
+        ----------
+        item_id : str
+            The ID of the file or folder to delete.
+        kind : str
+            Must be either "File" or "Folder".
+
+        Returns
+        -------
+        response : requests.Response
+            The response object from the CloudOS API.
+        """
+        if kind not in ("File", "Folder"):
+            raise ValueError("Invalid kind provided. Must be 'File' or 'Folder'.")
+
+        endpoint = "files" if kind == "File" else "folders"
+        url = f"{self.cloudos_url}/api/v1/{endpoint}/{item_id}?teamId={self.workspace_id}"
+
+        headers = {
+            "accept": "application/json",
+            "ApiKey": self.apikey
+        }
+
+        response = retry_requests_delete(url, headers=headers, verify=self.verify)
         return response

{cloudos_cli-2.35.0 → cloudos_cli-2.36.0}/cloudos_cli/utils/__init__.py

@@ -3,7 +3,7 @@ Utility functions and classes to use across the package.
 """
 
 from .errors import BadRequestException, TimeOutException, AccountNotLinkedException, JoBNotCompletedException, NotAuthorisedException, NoCloudForWorkspaceException
-from .requests import retry_requests_get, retry_requests_post, retry_requests_put
+from .requests import retry_requests_get, retry_requests_post, retry_requests_put, retry_requests_delete
 from .resources import format_bytes, ssl_selector
 from .cloud import find_cloud
 from .cloud import find_cloud

{cloudos_cli-2.35.0 → cloudos_cli-2.36.0}/cloudos_cli/utils/requests.py

@@ -107,3 +107,38 @@ def retry_requests_put(url, total=5, status_forcelist=[429, 500, 502, 503, 504],
     # Make a request using the session object
     response = session.put(url, **kwargs)
     return response
+
+
+def retry_requests_delete(url, total=5, status_forcelist=[429, 500, 502, 503, 504], **kwargs):
+    """
+    Wrap normal requests DELETE with an error retry strategy.
+
+    Parameters
+    ----------
+    url : str
+        The request URL.
+    total : int
+        Total number of retry attempts.
+    status_forcelist : list of int
+        HTTP status codes that should trigger a retry.
+    **kwargs :
+        Additional keyword arguments passed to `requests.delete`.
+
+    Returns
+    -------
+    requests.Response
+        The Response object returned by the API server.
+    """
+    retry_strategy = Retry(
+        total=total,
+        status_forcelist=status_forcelist,
+        allowed_methods=["DELETE"]
+    )
+    adapter = HTTPAdapter(max_retries=retry_strategy)
+
+    session = requests.Session()
+    session.mount("http://", adapter)
+    session.mount("https://", adapter)
+
+    response = session.delete(url, **kwargs)
+    return response

{cloudos_cli-2.35.0 → cloudos_cli-2.36.0}/cloudos_cli.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: cloudos_cli
-Version: 2.35.0
+Version: 2.36.0
 Summary: Python package for interacting with CloudOS
 Home-page: https://github.com/lifebit-ai/cloudos-cli
 Author: David Piñeyro
@@ -1013,6 +1013,38 @@ Please, note that in the above example a preconfigured profile has been used. If
     --workspace-id $WORKSPACE_ID \
     --project-name $PROJEC_NAME
 ```
+
+#### Copying files and folders
+
+Files and folders can be copied **from** anywhere in the project **to** `Data` or any of its subfolders programmatically (i.e `Data`, `Data/folder/file.txt`).
+
+1. The copy can happen **within the same project** running the following command:
+```
+cloudos datasets cp <souce_path> <destination_path> --profile <profile name>
+```
+where the source project as well as the destination one is the one defined in the profile.
+
+2. The move can also happen **across different projects**  within the same workspace by running the following command
+```
+cloudos datasets cp <source_path> <destiantion_path> --profile <profile_name> --destination-project-name <project_name>
+```
+In this case, only the source project is the one specified in the profile.
+
+Any of the `source_path` must be a full path; any `destination_path` must be a path starting with `Data` and finishing with the folder where to move the file/folder. An example of such command is:
+
+```
+cloudos datasets cp AnalysesResults/my_analysis/results/my_plot.png Data/plots 
+```
+
+Please, note that in the above example a preconfigured profile has been used. If no profile is provided and there is no default profile, the user will need to also provide the following flags
+```bash
+    --cloudos-url $CLOUDOS \
+    --apikey $MY_API_KEY \
+    --workspace-id $WORKSPACE_ID \
+    --project-name $PROJEC_NAME
+```
+
+
 #### Create a (virtual) folder
 
 New folders can be created within the `Data` dataset and its subfolders using the following command
@@ -1032,30 +1064,21 @@ Please, note that in the above example a preconfigured profile has been used. If
     --workspace-id $WORKSPACE_ID \
     --project-name $PROJEC_NAME
 ```
+#### Removing files and folders
 
-#### Copying files and folders
-
-Files and folders can be copied **from** anywhere in the project **to** `Data` or any of its subfolders programmatically (i.e `Data`, `Data/folder/file.txt`).
-
-1. The copy can happen **within the same project** running the following command:
-```
-cloudos datasets cp <souce_path> <destination_path> --profile <profile name>
-```
-where the source project as well as the destination one is the one defined in the profile.
+Files and folders can be removed from file explorer (in the `Data` datasets and its subfolders) using the following command
 
-2. The move can also happen **across different projects**  within the same workspace by running the following command
 ```
-cloudos datasets cp <source_path> <destiantion_path> --profile <profile_name> --destination-project-name <project_name>
+cloudos datasets rm <path> 
 ```
-In this case, only the source project is the one specified in the profile.
+where `path` is the full path to the file/folder to be removed.
 
-Any of the `source_path` must be a full path; any `destination_path` must be a path starting with `Data` and finishing with the folder where to move the file/folder. An example of such command is:
+Please, be aware that removing files and folders will only remove them from the file explorer and not from the corresponding cloud storage.
 
-```
-cloudos datasets cp AnalysesResults/my_analysis/results/my_plot.png Data/plots 
-```
+Please, keep in mind that you are only allowed to remove files or folders in `Data` or its subfolders.
 
 Please, note that in the above example a preconfigured profile has been used. If no profile is provided and there is no default profile, the user will need to also provide the following flags
+
 ```bash
     --cloudos-url $CLOUDOS \
     --apikey $MY_API_KEY \

cloudos_cli-2.35.0/cloudos_cli/_version.py

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