ee-client 0.0.0__py3-none-any.whl

ee_client-0.0.0.dist-info/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2024 Daniel Guerrero
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

ee_client-0.0.0.dist-info/METADATA

@@ -0,0 +1,142 @@
+Metadata-Version: 2.1
+Name: ee-client
+Version: 0.0.0
+Summary: extends the capabilities of the earthengine-api by providing custom session management and client interactions
+Author-email: Daniel Guerrero <dfgm2006@gmail.com>
+Project-URL: Homepage, https://github.com/dfguerrerom/ee-client
+Classifier: Development Status :: 3 - Alpha
+Classifier: Intended Audience :: Developers
+Classifier: Topic :: Software Development :: Build Tools
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Requires-Python: >=3.9
+Description-Content-Type: text/x-rst
+License-File: LICENSE
+Requires-Dist: earthengine-api
+Requires-Dist: httpx
+
+Earth Engine Session Client
+===========================
+
+ee-client extends the capabilities of the earthengine-api by providing custom session management and client interactions
+
+
+ee-client is a Python package designed to extend the capabilities of the Google Earth Engine (GEE) API by providing custom session management and client interactions. This package allows users to make authenticated requests to the Earth Engine REST API using their own credentials, facilitating seamless integration and customization of GEE functionalities.
+
+Key Features
+------------
+
+- Custom Authentication: 
+- Session Management: Handle sessions efficiently with reusable session objects that store credentials and project information.
+- Enhanced API Calls: Replace and extend existing GEE API calls with custom methods to suit specific project requirements.
+- Integration with Existing GEE Objects: Seamlessly integrate custom methods into existing Earth Engine objects, allowing for intuitive and familiar usage.
+
+
+Installation
+------------
+
+To install the package, simply use pip:
+
+.. code-block:: bash
+
+    pip install ee-client # Not yet developed
+
+Usage
+-----
+
+Here are a few examples of how to use ee-client in your projects:
+
+Initialization and Authentication
++++++++++++++++++++++++++++++++++
+
+.. code-block:: python
+
+    from eeclient import Session, get_info, get_asset
+
+    # Define your credentials and project ID
+    credentials = {
+        "client_id": "your_client_id",
+        "client_secret": "your_client_secret",
+        "refresh_token": "your_refresh_token",
+    }
+    project = "your_project"
+
+    # Create a session object
+    session = Session(credentials, project)
+
+
+Making API Calls
+++++++++++++++++
+
+.. code-block:: python
+
+    import ee
+
+    # Initialize the Earth Engine library and authenticate
+    ee.Initialize()
+
+    # Example: Get information about an Earth Engine object
+    result = get_info(session, ee.Number(5))
+    print(result)
+
+    # Example: Get asset information
+    asset_info = get_asset(session, "users/your_username/your_asset")
+    print(asset_info)
+
+Fetching Map Tiles:
++++++++++++++++++++
+
+.. code-block:: python
+    
+    from eeclient import get_map_id, get_map_tile
+
+    # Example: Get map ID for an Earth Engine image
+    image = ee.Image('COPERNICUS/S2/20190726T104031_20190726T104035_T31TGL')
+    map_id = get_map_id(session, image)
+
+    # Example: Get map tile layer
+    tile_layer = get_map_tile(map_id)
+    print(tile_layer)
+
+Integration with Existing GEE Objects
++++++++++++++++++++++++++++++++++++++
+
+WIP
+
+.. code-block:: python
+
+    import ee
+    import eeclient
+
+    # Custom method to get information about an Earth Engine Number object
+    def custom_get_info(self, session):
+        return get_info(session, self)
+
+    # Extend the Earth Engine Number class with the custom method
+    ee.Number.custom_get_info = custom_get_info
+
+    # Usage
+    number = ee.Number(5)
+    result = number.eeclient.get_info(session)
+    print(result)
+
+
+Contributing
+------------
+
+We welcome contributions from the community. Please feel free to submit issues and pull requests to help improve this package.
+
+Fork the repository
++++++++++++++++++++
+
+Create a new branch (git checkout -b feature-branch).
+Commit your changes (git commit -am 'Add new feature').
+Push to the branch (git push origin feature-branch).
+Create a new Pull Request.
+
+License
+-------
+This project is licensed under the MIT License - see the LICENSE file for details.
+

ee_client-0.0.0.dist-info/RECORD

@@ -0,0 +1,9 @@
+eeclient/__init__.py,sha256=fi46D4hRBsgbrqxGR7Jlk7npL_x-1Yji5OUSsQPRN64,180
+eeclient/client.py,sha256=H0dnc850BMVgqJ2nAQvYW-UJASm15Cs2dw-1RQL7M3U,1960
+eeclient/data.py,sha256=Pw0siBdo-pYNnrNsgYlC9GSQAMm9--xTCbedHE9GT-U,2302
+eeclient/exceptions.py,sha256=MvQj9X7urvCzflzCVsYR6czCePyqO1Ow0ukmVooAIT0,363
+ee_client-0.0.0.dist-info/LICENSE,sha256=hYVVtthZP962KZ7cmqS1lYvEmn--vcf4t6i819r-QNM,1072
+ee_client-0.0.0.dist-info/METADATA,sha256=KuO2nm2i4FvVF-ytFAZ46TGakDW9Oz84YuqEZPlNJyk,4243
+ee_client-0.0.0.dist-info/WHEEL,sha256=R0nc6qTxuoLk7ShA2_Y-UWkN8ZdfDBG2B6Eqpz2WXbs,91
+ee_client-0.0.0.dist-info/top_level.txt,sha256=VxCL1XOipzAHHkJWGuav31g_bR1idMa2EaB0MFL7J0g,9
+ee_client-0.0.0.dist-info/RECORD,,

ee_client-0.0.0.dist-info/WHEEL

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

ee_client-0.0.0.dist-info/top_level.txt

@@ -0,0 +1 @@
+eeclient

eeclient/__init__.py

@@ -0,0 +1,8 @@
+__title__ = "eeclient"
+__summary__ = "A client for Google Earth Engine"
+__version__ = "0.0.0"
+
+__author__ = "Daniel Guerrero"
+__email__ = "dfgm2006@gmail.com"
+
+__license__ = "MIT"

eeclient/client.py

@@ -0,0 +1,67 @@
+from typing import Literal
+import httpx
+from eeclient.exceptions import EERestException
+
+
+class Session:
+    def __init__(self, credentials, ee_project):
+
+        self.credentials = credentials
+        self.project = ee_project
+
+        self.headers = {
+            "x-goog-user-project": ee_project,
+            "Authorization": f"Bearer {self._get_access_token()}",
+        }
+
+        self.client = httpx.Client(headers=self.headers)
+
+    def _set_url_project(self, url):
+        """Set the project in the url"""
+
+        return url.format(project=self.project)
+
+    def rest_call(
+        self,
+        method: Literal["GET", "POST"],
+        url: str,
+        data: dict = None,
+    ):
+        """Make a call to the Earth Engine REST API"""
+
+        url = self._set_url_project(url)
+
+        with httpx.Client(headers=self.headers) as client:
+
+            response = (
+                client.post(url, data=data) if method == "POST" else client.get(url)
+            )
+
+        if response.status_code >= 400:
+            if "application/json" in response.headers.get("Content-Type", ""):
+                raise EERestException(response.json().get("error", {}))
+            else:
+                raise EERestException(
+                    {"code": response.status_code, "message": response.reason}
+                )
+
+        return response.json()
+
+    def _get_access_token(self):
+        """Get the access token from the refresh token"""
+
+        url = "https://oauth2.googleapis.com/token"
+
+        with httpx.Client() as client:
+
+            response = client.post(
+                url,
+                data={
+                    "client_id": self.credentials["client_id"],
+                    "client_secret": self.credentials["client_secret"],
+                    "refresh_token": self.credentials["refresh_token"],
+                    "grant_type": "refresh_token",
+                },
+            )
+
+        return response.json().get("access_token")

eeclient/data.py

@@ -0,0 +1,92 @@
+from ee.ee_exception import EEException
+
+import json
+import ee
+from ee import serializer
+from ee import _cloud_api_utils
+
+from ee.data import TileFetcher
+from ipyleaflet import TileLayer
+
+from eeclient.client import Session
+
+
+def get_map_id(session: Session, ee_image: ee.Image):
+
+    url = "https://earthengine.googleapis.com/v1alpha/projects/{project}/maps"
+
+    request_body = {
+        "expression": serializer.encode(ee_image, for_cloud_api=True),
+        "fileFormat": _cloud_api_utils.convert_to_image_file_format(None),
+        "bandIds": _cloud_api_utils.convert_to_band_list(None),
+    }
+
+    request_body = json.dumps(request_body)
+
+    response = session.rest_call("POST", url, data=request_body)
+    map_name = response["name"]
+
+    return map_name
+
+
+def get_map_tile(map_name: str):
+
+    _tile_base_url = "https://earthengine.googleapis.com"
+    version = "v1"
+
+    url_format = "%s/%s/%s/tiles/{z}/{x}/{y}" % (
+        _tile_base_url,
+        version,
+        map_name,
+    )
+
+    map_id = {
+        "mapid": map_name,
+        "token": "",
+        "tile_fetcher": TileFetcher(url_format, map_name=map_name),
+    }
+
+    return TileLayer(
+        url=map_id["tile_fetcher"].url_format,
+        attribution="Google Earth Engine",
+        name="name",
+        max_zoom=24,
+    )
+
+
+def get_info(session: Session, ee_object, workloadTag=None):
+    """Get the info of an Earth Engine object"""
+
+    data = {
+        "expression": serializer.encode(ee_object),
+        "workloadTag": workloadTag,
+    }
+
+    url = "https://earthengine.googleapis.com/v1/projects/{project}/value:compute"
+
+    return session.rest_call("POST", url, data=data)
+
+
+def get_asset(session: Session, ee_asset_id: str):
+    """Get the asset info from the asset id"""
+
+    url = (
+        "https://earthengine.googleapis.com/v1alpha/projects/{project}/assets/"
+        + ee_asset_id
+    )
+
+    return session.rest_call("GET", url)
+
+
+class EERestException(EEException):
+    def __init__(self, error):
+        self.message = error.get("message", "EE responded with an error")
+        super().__init__(self.message)
+        self.code = error.get("code", -1)
+        self.status = error.get("status", "UNDEFINED")
+        self.details = error.get("details")
+
+
+getInfo = get_info
+getAsset = get_asset
+getMapTile = get_map_tile

eeclient/exceptions.py

@@ -0,0 +1,10 @@
+from ee.ee_exception import EEException
+
+
+class EERestException(EEException):
+    def __init__(self, error):
+        self.message = error.get("message", "EE responded with an error")
+        super().__init__(self.message)
+        self.code = error.get("code", -1)
+        self.status = error.get("status", "UNDEFINED")
+        self.details = error.get("details")