Metadata-Version: 2.4
Name: geestac
Version: 0.0.0
Summary: Google Earth Engine STAC
Project-URL: Homepage, https://github.com/fitoprincipe/geestac
Author-email: Rodrigo Esteban Principe <fitoprincipe82@gmail.com>
License: MIT
License-File: AUTHORS.rst
License-File: LICENSE
Keywords: Google Earth Engine,Python,STAC,geetools,skeleton
Classifier: Development Status :: 3 - Alpha
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Requires-Python: >=3.10
Requires-Dist: deprecated>=1.2.14
Requires-Dist: earthengine-api
Requires-Dist: requests
Provides-Extra: doc
Requires-Dist: pydata-sphinx-theme; extra == 'doc'
Requires-Dist: sphinx-autoapi; extra == 'doc'
Requires-Dist: sphinx-copybutton; extra == 'doc'
Requires-Dist: sphinx-design; extra == 'doc'
Requires-Dist: sphinx>=6.2.1; extra == 'doc'
Provides-Extra: test
Requires-Dist: pytest; extra == 'test'
Requires-Dist: pytest-cov; extra == 'test'
Requires-Dist: pytest-deadfixtures; extra == 'test'
Description-Content-Type: text/x-rst


Google Earth Engine STAC (geestac)
##################################

.. |license| image:: https://img.shields.io/badge/License-MIT-yellow.svg?logo=opensourceinitiative&logoColor=white
    :target: LICENSE
    :alt: License: MIT

.. |commit| image:: https://img.shields.io/badge/Conventional%20Commits-1.0.0-yellow.svg?logo=git&logoColor=white
   :target: https://conventionalcommits.org
   :alt: conventional commit

.. |ruff| image:: https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/astral-sh/ruff/main/assets/badge/v2.json
   :target: https://github.com/astral-sh/ruff
   :alt: ruff badge

.. |prettier| image:: https://img.shields.io/badge/code_style-prettier-ff69b4.svg?logo=prettier&logoColor=white
   :target: https://github.com/prettier/prettier
   :alt: prettier badge

.. |pre-commmit| image:: https://img.shields.io/badge/pre--commit-active-yellow?logo=pre-commit&logoColor=white
    :target: https://pre-commit.com/
    :alt: pre-commit

.. |pypi| image:: https://img.shields.io/pypi/v/geestac?color=blue&logo=pypi&logoColor=white
    :target: https://pypi.org/project/geestac/
    :alt: PyPI version

.. |build| image:: https://img.shields.io/github/actions/workflow/status/fitoprincipe/geestac/unit.yaml?logo=github&logoColor=white
    :target: https://github.com/fitoprincipe/geestac/actions/workflows/unit.yaml
    :alt: build

.. |coverage| image:: https://img.shields.io/codecov/c/github/fitoprincipe/geestac?logo=codecov&logoColor=white
    :target: https://codecov.io/gh/fitoprincipe/geestac
    :alt: Test Coverage

.. |docs| image:: https://img.shields.io/readthedocs/geestac?logo=readthedocs&logoColor=white
    :target: https://geestac.readthedocs.io/en/latest/
    :alt: Documentation Status

|license| |commit| |ruff| |prettier| |pre-commmit| |pypi| |build| |coverage| |docs|

Overview
--------

This packages provides an easy and straightforward way of getting Google Earth
Engine STAC information.

To take fully advantage of this package is recommended to use it in runtime
due to `lazy evaluation <https://en.wikipedia.org/wiki/Lazy_evaluation>`__

Installation
------------

Currently not available in pypi (will as soon as first version is ready).

Usage
-----

.. code-block:: python

    from geestac import eecatalog

    # a lazy object does not contain the complete data but only the reference (name and url)
    landsat_lazy = eecatalog.Landsat

    # to fetch all data you need to call it
    landast = eecatalog.Landsat()

    # if you do this in runtime, the `landsat` object contains all datasets as attributes
    # if you don't do it in runtime you won't be able to see the datasets (attributes)

    # it works the same with datasets
    # lazy dataset
    l9_lazy = landsat.LC09_C02_T1
    # fetch L9 data
    l9 = landsat.LC09_C02_T1()


Credits
-------
Author: Rodrigo E. Principe

This package was created with `Copier <https://copier.readthedocs.io/en/latest/>`__ and the `@12rambau/pypackage <https://github.com/12rambau/pypackage>`__ 0.1.16 project template.
