gee-toolbox 0.1.0__tar.gz

gee_toolbox-0.1.0/LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+1.  Definitions.
+
+    "License" shall mean the terms and conditions for use, reproduction,
+    and distribution as defined by Sections 1 through 9 of this document.
+
+    "Licensor" shall mean the copyright owner or entity authorized by
+    the copyright owner that is granting the License.
+
+    "Legal Entity" shall mean the union of the acting entity and all
+    other entities that control, are controlled by, or are under common
+    control with that entity. For the purposes of this definition,
+    "control" means (i) the power, direct or indirect, to cause the
+    direction or management of such entity, whether by contract or
+    otherwise, or (ii) ownership of fifty percent (50%) or more of the
+    outstanding shares, or (iii) beneficial ownership of such entity.
+
+    "You" (or "Your") shall mean an individual or Legal Entity
+    exercising permissions granted by this License.
+
+    "Source" form shall mean the preferred form for making modifications,
+    including but not limited to software source code, documentation
+    source, and configuration files.
+
+    "Object" form shall mean any form resulting from mechanical
+    transformation or translation of a Source form, including but
+    not limited to compiled object code, generated documentation,
+    and conversions to other media types.
+
+    "Work" shall mean the work of authorship, whether in Source or
+    Object form, made available under the License, as indicated by a
+    copyright notice that is included in or attached to the work
+    (an example is provided in the Appendix below).
+
+    "Derivative Works" shall mean any work, whether in Source or Object
+    form, that is based on (or derived from) the Work and for which the
+    editorial revisions, annotations, elaborations, or other modifications
+    represent, as a whole, an original work of authorship. For the purposes
+    of this License, Derivative Works shall not include works that remain
+    separable from, or merely link (or bind by name) to the interfaces of,
+    the Work and Derivative Works thereof.
+
+    "Contribution" shall mean any work of authorship, including
+    the original version of the Work and any modifications or additions
+    to that Work or Derivative Works thereof, that is intentionally
+    submitted to Licensor for inclusion in the Work by the copyright owner
+    or by an individual or Legal Entity authorized to submit on behalf of
+    the copyright owner. For the purposes of this definition, "submitted"
+    means any form of electronic, verbal, or written communication sent
+    to the Licensor or its representatives, including but not limited to
+    communication on electronic mailing lists, source code control systems,
+    and issue tracking systems that are managed by, or on behalf of, the
+    Licensor for the purpose of discussing and improving the Work, but
+    excluding communication that is conspicuously marked or otherwise
+    designated in writing by the copyright owner as "Not a Contribution."
+
+    "Contributor" shall mean Licensor and any individual or Legal Entity
+    on behalf of whom a Contribution has been received by Licensor and
+    subsequently incorporated within the Work.
+
+2.  Grant of Copyright License. Subject to the terms and conditions of
+    this License, each Contributor hereby grants to You a perpetual,
+    worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+    copyright license to reproduce, prepare Derivative Works of,
+    publicly display, publicly perform, sublicense, and distribute the
+    Work and such Derivative Works in Source or Object form.
+
+3.  Grant of Patent License. Subject to the terms and conditions of
+    this License, each Contributor hereby grants to You a perpetual,
+    worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+    (except as stated in this section) patent license to make, have made,
+    use, offer to sell, sell, import, and otherwise transfer the Work,
+    where such license applies only to those patent claims licensable
+    by such Contributor that are necessarily infringed by their
+    Contribution(s) alone or by combination of their Contribution(s)
+    with the Work to which such Contribution(s) was submitted. If You
+    institute patent litigation against any entity (including a
+    cross-claim or counterclaim in a lawsuit) alleging that the Work
+    or a Contribution incorporated within the Work constitutes direct
+    or contributory patent infringement, then any patent licenses
+    granted to You under this License for that Work shall terminate
+    as of the date such litigation is filed.
+
+4.  Redistribution. You may reproduce and distribute copies of the
+    Work or Derivative Works thereof in any medium, with or without
+    modifications, and in Source or Object form, provided that You
+    meet the following conditions:
+
+    (a) You must give any other recipients of the Work or
+    Derivative Works a copy of this License; and
+
+    (b) You must cause any modified files to carry prominent notices
+    stating that You changed the files; and
+
+    (c) You must retain, in the Source form of any Derivative Works
+    that You distribute, all copyright, patent, trademark, and
+    attribution notices from the Source form of the Work,
+    excluding those notices that do not pertain to any part of
+    the Derivative Works; and
+
+    (d) If the Work includes a "NOTICE" text file as part of its
+    distribution, then any Derivative Works that You distribute must
+    include a readable copy of the attribution notices contained
+    within such NOTICE file, excluding those notices that do not
+    pertain to any part of the Derivative Works, in at least one
+    of the following places: within a NOTICE text file distributed
+    as part of the Derivative Works; within the Source form or
+    documentation, if provided along with the Derivative Works; or,
+    within a display generated by the Derivative Works, if and
+    wherever such third-party notices normally appear. The contents
+    of the NOTICE file are for informational purposes only and
+    do not modify the License. You may add Your own attribution
+    notices within Derivative Works that You distribute, alongside
+    or as an addendum to the NOTICE text from the Work, provided
+    that such additional attribution notices cannot be construed
+    as modifying the License.
+
+    You may add Your own copyright statement to Your modifications and
+    may provide additional or different license terms and conditions
+    for use, reproduction, or distribution of Your modifications, or
+    for any such Derivative Works as a whole, provided Your use,
+    reproduction, and distribution of the Work otherwise complies with
+    the conditions stated in this License.
+
+5.  Submission of Contributions. Unless You explicitly state otherwise,
+    any Contribution intentionally submitted for inclusion in the Work
+    by You to the Licensor shall be under the terms and conditions of
+    this License, without any additional terms or conditions.
+    Notwithstanding the above, nothing herein shall supersede or modify
+    the terms of any separate license agreement you may have executed
+    with Licensor regarding such Contributions.
+
+6.  Trademarks. This License does not grant permission to use the trade
+    names, trademarks, service marks, or product names of the Licensor,
+    except as required for reasonable and customary use in describing the
+    origin of the Work and reproducing the content of the NOTICE file.
+
+7.  Disclaimer of Warranty. Unless required by applicable law or
+    agreed to in writing, Licensor provides the Work (and each
+    Contributor provides its Contributions) on an "AS IS" BASIS,
+    WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+    implied, including, without limitation, any warranties or conditions
+    of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+    PARTICULAR PURPOSE. You are solely responsible for determining the
+    appropriateness of using or redistributing the Work and assume any
+    risks associated with Your exercise of permissions under this License.
+
+8.  Limitation of Liability. In no event and under no legal theory,
+    whether in tort (including negligence), contract, or otherwise,
+    unless required by applicable law (such as deliberate and grossly
+    negligent acts) or agreed to in writing, shall any Contributor be
+    liable to You for damages, including any direct, indirect, special,
+    incidental, or consequential damages of any character arising as a
+    result of this License or out of the use or inability to use the
+    Work (including but not limited to damages for loss of goodwill,
+    work stoppage, computer failure or malfunction, or any and all
+    other commercial damages or losses), even if such Contributor
+    has been advised of the possibility of such damages.
+
+9.  Accepting Warranty or Additional Liability. While redistributing
+    the Work or Derivative Works thereof, You may choose to offer,
+    and charge a fee for, acceptance of support, warranty, indemnity,
+    or other liability obligations and/or rights consistent with this
+    License. However, in accepting such obligations, You may act only
+    on Your own behalf and on Your sole responsibility, not on behalf
+    of any other Contributor, and only if You agree to indemnify,
+    defend, and hold each Contributor harmless for any liability
+    incurred by, or claims asserted against, such Contributor by reason
+    of your accepting any such warranty or additional liability.
+
+END OF TERMS AND CONDITIONS
+
+APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+Copyright 2024 [name of copyright owner]
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.

gee_toolbox-0.1.0/PKG-INFO

@@ -0,0 +1,33 @@
+Metadata-Version: 2.1
+Name: gee-toolbox
+Version: 0.1.0
+Summary: Common functions and tasks for Google Earth Engine Assets
+Home-page: https://github.com/silversky54/gee-toolbox
+License: Apache-2.0
+Keywords: earthengine,gee,google-earth-engine
+Author: Erick G
+Author-email: erick.linares@gmail.com
+Maintainer: Erick G
+Maintainer-email: erick.linares@gmail.com
+Requires-Python: >=3.12,<4.0
+Classifier: Development Status :: 3 - Alpha
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: Apache Software License
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Topic :: Software Development :: Libraries
+Classifier: Topic :: Utilities
+Requires-Dist: earthengine-api (>=0.1.418,<0.2.0)
+Requires-Dist: geetools (>=1.4.0,<2.0.0)
+Project-URL: Repository, https://github.com/silversky54/gee-toolbox
+Description-Content-Type: text/markdown
+
+# Google Earth Engine custom Toolbox for common tasks
+
+**gee-toolbox** is a python package that serves as a custom toolbox with a variety of functions to execute common tasks related to Google Earth Engine. It Extends the functionality of GEE python client library and some other packages to manage GEE assets or process Images and ImageCollections.
+
+## Installation
+
+This package can currently only be installed from google
+

gee_toolbox-0.1.0/README.md

@@ -0,0 +1,7 @@
+# Google Earth Engine custom Toolbox for common tasks
+
+**gee-toolbox** is a python package that serves as a custom toolbox with a variety of functions to execute common tasks related to Google Earth Engine. It Extends the functionality of GEE python client library and some other packages to manage GEE assets or process Images and ImageCollections.
+
+## Installation
+
+This package can currently only be installed from google

gee_toolbox-0.1.0/gee_toolbox/gee/assets.py

@@ -0,0 +1,320 @@
+import ee
+from geetools.Asset import Asset
+import logging
+from typing import List, Dict, Any
+
+
+def _request_del_confirmation() -> bool:
+    # request Y/N confirmation from user. No input will return False
+    confirmation_loop = True
+    while confirmation_loop:
+        delete_confirmation = input(
+            "Are you sure you want to delete this asset? (Y/N)"
+        ).lower()
+        if delete_confirmation in ["y", "n", ""]:
+            confirmation_loop = False
+
+    return delete_confirmation == "y"
+
+
+def _make_del_warning(asset: str, objects_list: list) -> str:
+    # count items in asset_types that are equal to type 'IMAGE_COLLECTION'
+    image_collections = len(
+        [type for type in objects_list if type == "IMAGE_COLLECTION"]
+    )
+    images = len([type for type in objects_list if type == "IMAGE"])
+    tables = len([type for type in objects_list if type == "TABLE"])
+    folders = len([type for type in objects_list if type == "FOLDER"])
+    warn_text = (
+        "******************************************************\n"
+        "WARNING\n"
+        "******************************************************\n"
+        "You are about to delete the following assets:\n"
+        f"-Images: {images}\n"
+        f"-Image Collections: {image_collections}\n"
+        f"-Tables: {tables}\n"
+        f"-Folders: {folders}\n"
+        f"Target: {asset}\n"
+    )
+    return warn_text
+
+
+ALLOWED_ASSET_TYPES = ["IMAGE", "TABLE", "FOLDER", "IMAGE_COLLECTION"]
+
+
+def _check_asset_types(asset_types: str | List[str]) -> List[str]:
+    # verify allowed asset types
+    if not asset_types:
+        asset_types = ALLOWED_ASSET_TYPES
+    if type(asset_types) == str:
+        asset_types = [asset_types]
+
+    # Convert all asset types to uppercase
+    asset_types = [asset_type.upper() for asset_type in asset_types]
+
+    # if asset types not in valid types, raise an error
+    if not all([asset in ALLOWED_ASSET_TYPES for asset in asset_types]):
+        raise ValueError(f"Invalid asset type(s). Must be one of {ALLOWED_ASSET_TYPES}")
+
+    return asset_types
+
+
+def get_asset_names(asset_list: list) -> List:
+    return [asset["name"] for asset in asset_list]
+
+
+def get_asset_types(asset_list: list) -> List:
+    return [asset["type"] for asset in asset_list]
+
+
+# Creating alternative function to list assets to include filtering by asset type and inclusion/exclusion of parent folder
+def list_assets(
+    parent: str,
+    asset_types: str | list = [],
+    recursive: bool = False,
+    inclusive: bool = False,
+    expand_image_collections: bool = False,
+    image_collections_exclusively: bool = False,
+) -> List:
+    """
+    lists assets from an assets folder or Image Collection in GEE. User can specify what type of assets to list.
+
+    Args:
+        parent: path to the parent folder of the assets
+        asset_type: asset types to list. ['IMAGE', 'TABLE', 'FOLDER', 'IMAGE_COLLECTION']. If empty, all asset types are listed
+        recursive: Recursively search for assets in sub-folders
+        inclusive: Include the parent folder in the list
+
+    reference: https://github.com/spatialthoughts/projects/blob/master/ee-python/list_all_assets.py
+    """
+
+    # TODO - IF parent is image collection, should expand_image_collections be forced to true?
+    # TODO - Add handler for when results are paginated
+    # TODO - IF list is empty should this fail??
+
+    asset_types = _check_asset_types(asset_types)
+
+    # If Asset is not a folder or image collection raise error
+    try:
+        _parent = Asset(parent)
+        parent_type = _parent.type
+        if parent_type not in ["FOLDER", "IMAGE_COLLECTION"]:
+            raise ValueError("Path provided is not a Folder or Image Collection")
+    except (ValueError, ee.EEException) as e:
+        logging.error(e)
+        raise e
+
+    # If parent is an image collection, expand_image_collections is forced to True
+    if parent_type == "IMAGE_COLLECTION":
+        expand_image_collections = True
+
+    # List assets in the parent folder
+    try:
+        child_assets = ee.data.listAssets({"parent": _parent.as_posix()})["assets"]
+    except ee.EEException as e:
+        logging.warning(e)
+        raise e
+
+    asset_list = []
+
+    # if Inclusive is True add container info to the list
+    if inclusive:
+        asset_list.append({"name": _parent.as_posix(), "type": parent_type})
+
+    # Iterate over child assets.
+    for child_asset in child_assets:
+        # if not image_collections_exclusively, include everything
+        if (
+            not image_collections_exclusively
+            or child_asset["type"] != "IMAGE"
+            or parent_type == "IMAGE_COLLECTION"
+        ):
+            asset_list.append(
+                {"name": child_asset["name"], "type": child_asset["type"]}
+            )
+
+        # Recursively call the function to get child assets
+        if recursive and child_asset["type"] == "FOLDER":
+            asset_list.extend(
+                list_assets(
+                    child_asset["name"],
+                    asset_types=[],  # Bring all, filter at the end
+                    recursive=True,  # Implicit from IF
+                    inclusive=False,  # False because parents are included above
+                    expand_image_collections=expand_image_collections,
+                    image_collections_exclusively=image_collections_exclusively,
+                )
+            )
+        if expand_image_collections and child_asset["type"] == "IMAGE_COLLECTION":
+            # Recursively call the function to get child assets
+            asset_list.extend(
+                list_assets(
+                    child_asset["name"],
+                    asset_types=[],  # Bring all, filter at the end
+                    recursive=True,  # Indiferente, image collections are not recursive
+                    inclusive=False,  # False because parents are included above
+                    expand_image_collections=True,  # Implicit from IF
+                    image_collections_exclusively=False,
+                )
+            )
+
+    # Filter assets not in asset_types
+    asset_list = [asset for asset in asset_list if asset["type"] in asset_types]
+
+    return asset_list
+
+
+def prune(
+    asset: str,
+    asset_types: str | List[str] = [],
+    recursive: bool = False,
+    expand_image_collections: bool = False,
+    inclusive: bool = True,
+    silent: bool = False,
+    dry_run: bool = False,
+) -> Dict[str, List[str]]:
+    """
+    Deletes Google Earth Engine assets in google projects.
+
+    Prune function can delete multiple assets if the specified asset is a folder or image collection. Delete recursively
+    in sub-folders by setting recursive=True. Specific asset types can be targeted using the asset_types argument. If
+    asset_types is empty, all asset types will be considered.
+    Folders and Image Collections will be excluded if not included in asset_types even if inclusive=True.
+    Deleting Image Collections will automatically include it's images in which case expand_image_collections=True is required.
+    Images in Image Collections can be targeted exclusively by setting image_collections_exclusively=True, this will
+    omit images that are not in an Image Collection.
+
+    Args:
+        asset (str): The path to the asset.
+        asset_types (str | List[str], optional): One or more asset types to delete. Defaults to []. Valid asset
+            types are 'IMAGE', 'TABLE', 'FOLDER', 'IMAGE_COLLECTION'. An empty list [] deletes all asset types.
+        recursive (bool, optional): Whether to include sub-folders recursively. Defaults to False.
+            Required if deleting folders.
+        expand_image_collections (bool, optional): Whether to include images in image collections. Defaults to False.
+            Required if deleting folders or image collections.
+        inclusive (bool, optional): Whether to include the top asset if asset is a folder or image collection.
+            Defaults to True. Ignored if Folder or Image Collection is not included in asset_types.
+        silent (bool, optional): Whether to skip the confirmation prompt. Defaults to False.
+            Use with caution, will delete all assets without requesting confirmation.
+        dry_run (bool, optional): List all assets to delete without deleting them. Defaults to False.
+    Returns:
+        Dict: A dictionary containing the results of the deletion operation. The dictionary has the following keys:
+            - "deleted": List of assets successfully deleted.
+            - "failed": list of assets that failed to delete.
+            - "skipped": List of assets that were skipped from deleting.
+    Raises:
+        ValueError: If asset_types includes 'FOLDER' but omits any other required asset types.
+        ValueError: If deleting a folder but recursive=False or expand_image_collections=False.
+        ValueError: If deleting an image collection but expand_image_collections=False.
+    """
+
+    _asset = Asset(asset)
+    results = {"deleted": [], "failed": [], "skipped": []}
+
+    _asset.exists(raised=True)
+    asset_types = _check_asset_types(asset_types)
+
+    # if asset_types includes FOLDER, asset_types should also include all other asset types or raise error
+    if any([asset_type == "FOLDER" for asset_type in asset_types]):
+        if not all(
+            [allowed_type in asset_types for allowed_type in ALLOWED_ASSET_TYPES]
+        ):
+            raise ValueError(
+                (
+                    "asset_types includes 'FOLDER' but omits other required asset types. "
+                    "Prefer asset_types=[] to delete folders and all their contents."
+                )
+            )
+
+    # IF deleting folders, recursive and expand_image_collections need to be True
+    if (
+        "FOLDER" in asset_types
+        and not _asset.is_image_collection()
+        and (not recursive or not expand_image_collections)
+    ):
+        raise ValueError(
+            "Deleting a folder requires recursive=True and expand_image_collections=True"
+        )
+
+    # If Deleting image collections, expand_image_collections needs to be True
+    if "IMAGE_COLLECTION" in asset_types and not expand_image_collections:
+        raise ValueError(
+            "Deleting an image collection requires expand_image_collections=True"
+        )
+
+    # if deleting image collections  and not images (explicitly)
+    # add 'IMAGE' to asset_types and set image_collection_exclusively=True
+    image_collections_exclusively = False
+    if "IMAGE_COLLECTION" in asset_types and not "IMAGE" in asset_types:
+        image_collections_exclusively = True
+        asset_types.append("IMAGE")
+
+    is_container = (
+        _asset.is_project() or _asset.is_folder() or _asset.is_image_collection()
+    )
+
+    # list objects (images, tables, folders, imageCollections, etc) in folder and sub folders
+    if is_container:
+        asset_list = list_assets(
+            parent=_asset.as_posix(),
+            asset_types=asset_types,
+            recursive=recursive,
+            inclusive=inclusive,
+            expand_image_collections=expand_image_collections,
+            image_collections_exclusively=image_collections_exclusively,
+        )
+
+        # Split and sort per level of hierarchy. Recursive deleting will fail If not deleted in reverse order
+        assets_ordered: dict = {}
+        for _target_asset in asset_list:
+            _target_asset = Asset(_target_asset["name"])
+            lvl = len(_target_asset.parts)
+            assets_ordered.setdefault(lvl, [])
+            assets_ordered[lvl].append(_target_asset)
+        assets_ordered = dict(sorted(assets_ordered.items(), reverse=True))
+
+    else:
+        asset_list = [{"name": _asset.as_posix(), "type": _asset.type}]
+
+    print(_make_del_warning(_asset.as_posix(), get_asset_types(asset_list)))
+
+    # End if Dry Run
+    if dry_run:
+        results["skipped"] = get_asset_names(asset_list)
+        print("Dry run, no items will be deleted")
+        return results
+
+    # Warn user and ask for confirmation
+    if silent:
+        delete_confirmation = True
+    else:
+        delete_confirmation = _request_del_confirmation()
+
+    # Proceed to delete
+    # Not using Asset.delete() method. Need to be able to delete specific asset types only
+    if delete_confirmation:
+
+        def _delete(asset: Asset) -> None:
+            try:
+                ee.data.deleteAsset(str(asset))
+                results["deleted"].append(str(asset))
+            except Exception as e:
+                results["failed"].append(str(asset))
+
+        print(f"Deleting {len(asset_list)} items from {_asset.as_posix()}")
+
+        # delete all items starting from the more nested ones
+        for lvl in assets_ordered:
+            [_delete(asset) for asset in assets_ordered[lvl]]
+
+        print(
+            f"Deleted {len(results['deleted'])} items, {len(results['failed'])} items failed to delete"
+        )
+    else:
+        results["skipped"] = get_asset_names(asset_list)
+        print(f"No items deleted from {_asset.as_posix()}")
+    return results
+
+
+if __name__ == "__main__":
+    pass

gee_toolbox-0.1.0/pyproject.toml

@@ -0,0 +1,32 @@
+[tool.poetry]
+name = "gee-toolbox"
+version = "0.1.0"
+description = "Common functions and tasks for Google Earth Engine Assets"
+license = "Apache-2.0"
+authors = ["Erick G <erick.linares@gmail.com>"]
+maintainers = ["Erick G <erick.linares@gmail.com>"]
+readme = "README.md"
+repository = "https://github.com/silversky54/gee-toolbox"
+keywords = ["earthengine", "gee", "google-earth-engine"]
+classifiers = [
+    "Development Status :: 3 - Alpha",
+    "Intended Audience :: Developers",
+    "Topic :: Utilities",
+    "Topic :: Software Development :: Libraries",
+    "License :: OSI Approved :: Apache Software License",
+    "Programming Language :: Python :: 3",
+    "Operating System :: OS Independent"
+    ]
+
+[tool.poetry.dependencies]
+python = "^3.12"
+earthengine-api = "^0.1.418"
+geetools = "^1.4.0"
+
+
+[tool.poetry.group.dev.dependencies]
+jupyter = "^1.1.1"
+
+[build-system]
+requires = ["poetry-core"]
+build-backend = "poetry.core.masonry.api"