ugbio_cloud_utils 1.4.3__py3-none-any.whl

ugbio_cloud_utils/cloud_sync.py

@@ -0,0 +1,159 @@
+import argparse
+import os
+import sys
+
+import boto3
+from google.cloud import storage
+
+
+def dir_path(string, *, check_cloud_path=False):
+    if os.path.isdir(string):
+        return string
+
+    if check_cloud_path:
+        if not string.startswith("gs://") and not string.startswith("s3://"):
+            raise ValueError(f"Invalid cloud path {string}\nMust be an s3 or gs path")
+        return string
+
+    raise NotADirectoryError(string)
+
+
+def download_from_gs(bucket_name, source_blob_name, destination_file_name):
+    """Downloads a blob from the bucket."""
+    # bucket_name = "your-bucket-name"
+    # source_blob_name = "storage-object-name"
+    # destination_file_name = "local/path/to/file"
+
+    storage_client = storage.Client()
+
+    bucket = storage_client.bucket(bucket_name)
+    blob = bucket.blob(source_blob_name)
+    blob.download_to_filename(destination_file_name)
+
+
+def download_from_s3(bucket_name, object_name, destination_file_name):
+    client = boto3.Session(profile_name="default").client("s3")
+    client.download_file(bucket_name, object_name, destination_file_name)
+
+
+def optional_cloud_sync(
+    cloud_path_in,
+    local_dir_in="/data",
+    *,
+    print_output=False,
+    force_download=False,
+    raise_error_is_file_exists=False,
+    dry_run=False,
+):
+    if cloud_path_in.startswith(("gs://", "s3://")):
+        return cloud_sync(
+            cloud_path_in, local_dir_in, print_output, force_download, raise_error_is_file_exists, dry_run
+        )
+    return cloud_path_in
+
+
+def cloud_sync(  # noqa C901,PLR0912
+    cloud_path_in,
+    local_dir_in="/data",
+    *,
+    print_output=False,
+    force_download=False,
+    raise_error_is_file_exists=False,
+    dry_run=False,
+):
+    """Download a file from the cloud to a respective local directory with the same name
+
+    Parameters
+    ----------
+    cloud_path_in: str
+        Path to a file on the cloud (gs / s3), can also be a local file in which case nothing will happen
+    local_dir_in: str, optional
+        Local directory to which files will be downloaded, under subdirectory "cloud_sync"
+    print_output: bool, optional
+        Print log messages
+    force_download: bool, optional
+        If True, download file again even if file with the target name exists (default False)
+    raise_error_is_file_exists: bool, optional
+        If True and local file already exists, raise ValueError (default False)
+    dry_run: bool, optional
+        If True, return local path without downloading (default False)
+    :raises NotADirectoryError: Not a directory
+    :raises FileExistsError: Target local file exists
+    :raises NotImplementedError: Unsupported cloud service
+    :raises KeyboardInterrupt: Keyboard interrupt
+    :returns: a local path to which file was downloaded. If cloud_path_in was an existing local
+              file it is returned as is
+    -------
+
+    """
+    if os.path.isfile(cloud_path_in):
+        return cloud_path_in
+    if not os.path.isdir(local_dir_in):
+        raise NotADirectoryError(local_dir_in)
+    dir_path(cloud_path_in, check_cloud_path=True)
+    cloud_service = cloud_path_in.split(":")[0]
+    bucket = cloud_path_in.split("/")[2]
+    blob = "/".join(cloud_path_in.split("/")[3:])
+    local_path = os.path.join(
+        local_dir_in,
+        "cloud_sync",
+        cloud_service,
+        bucket,
+        blob,
+    )
+    if dry_run:
+        return local_path
+    if not force_download and os.path.isfile(local_path):
+        if raise_error_is_file_exists:
+            raise FileExistsError(f"target local file {local_path} exists")
+        if print_output:
+            sys.stdout.write(f"Local file {local_path} already exists, skipping...\n")
+    else:
+        try:
+            if print_output:
+                sys.stdout.write(f"Downloading to {local_path}\n")
+            os.makedirs(os.path.dirname(local_path), exist_ok=True)
+            if cloud_service == "gs":
+                download_from_gs(bucket, blob, local_path)
+            elif cloud_service == "s3":
+                download_from_s3(bucket, blob, local_path)
+            else:
+                raise NotImplementedError()
+        except KeyboardInterrupt:
+            if os.path.isfile(local_path):
+                sys.stdout.write(f"Keyboard Interrupt - removing incomplete file {local_path}\n")
+                os.remove(local_path)
+            raise
+
+    return local_path
+
+
+def parse_args(argv):
+    parser = argparse.ArgumentParser(description=run.__doc__)
+    parser.add_argument("cloud_path", type=str, help="full path to aws s3 / google storage file")
+    parser.add_argument(
+        "--local_dir",
+        type=dir_path,
+        default="/data",
+        help="local directory the files will sync to",
+    )
+    args = parser.parse_args(argv[1:])
+    return args
+
+
+def run(argv: list[str]):
+    """Download aws s3 or google storage file to a respective local path"""
+    args = parse_args(argv)
+    cloud_path = args.cloud_path
+    local_dir = args.local_dir
+    if not os.path.isdir(local_dir):
+        raise ValueError(f"local_dir {local_dir} does not exist")
+    cloud_sync(cloud_path, local_dir, print_output=True)
+
+
+def main():
+    run(sys.argv)
+
+
+if __name__ == "__main__":
+    run(sys.argv)

ugbio_cloud_utils-1.4.3.dist-info/METADATA

@@ -0,0 +1,19 @@
+Metadata-Version: 2.1
+Name: ugbio_cloud_utils
+Version: 1.4.3
+Summary: Ultima Genomics cloud python utils
+Author-email: Avigail Moldovam  <avigail.moldovan@ultimagen.com>
+Requires-Python: >=3.11
+Description-Content-Type: text/markdown
+Requires-Dist: boto3>=1.35.66
+Requires-Dist: google-cloud-storage>=2.19.0
+
+# ugbio_cloud_utils
+
+This module includes cloud (AWS/GS) python scripts:
+
+List of tools:
+
+1. **cloud_sync** - Download aws s3 or google storage file to a respective local path
+
+   Run `uv run cloud_sync --help` for more details.

ugbio_cloud_utils-1.4.3.dist-info/RECORD

@@ -0,0 +1,7 @@
+ugbio_cloud_utils/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+ugbio_cloud_utils/cloud_sync.py,sha256=t9n3AJbZNwQiGkaMVGXDpZ1Zx-_kfyhPKFIw_D2X6jA,5192
+ugbio_cloud_utils-1.4.3.dist-info/METADATA,sha256=7zAO81Z_eHCpW16U2xaFmSCrVrF2vCiZxSu6421NR_k,538
+ugbio_cloud_utils-1.4.3.dist-info/WHEEL,sha256=PZUExdf71Ui_so67QXpySuHtCi3-J3wvF4ORK6k_S8U,91
+ugbio_cloud_utils-1.4.3.dist-info/entry_points.txt,sha256=HEctXBVCAXP9qorkrhKidMG2Rq5aA0O6A_LZmhN6X4g,89
+ugbio_cloud_utils-1.4.3.dist-info/top_level.txt,sha256=RA9O5nTwkzMa9Bvab5CNRKw5WPkgvI4rA6TjFcREny0,18
+ugbio_cloud_utils-1.4.3.dist-info/RECORD,,

ugbio_cloud_utils-1.4.3.dist-info/WHEEL

@@ -0,0 +1,5 @@
+Wheel-Version: 1.0
+Generator: setuptools (75.6.0)
+Root-Is-Purelib: true
+Tag: py3-none-any
+

ugbio_cloud_utils-1.4.3.dist-info/entry_points.txt

@@ -0,0 +1,3 @@
+[console_scripts]
+cloud_sync = ugbio_cloud_utils.cloud_sync:main
+run_tests = pytest:main

ugbio_cloud_utils-1.4.3.dist-info/top_level.txt

@@ -0,0 +1 @@
+ugbio_cloud_utils