V0.0.6

.github/workflows/pytest-prod.yaml

@@ -11,6 +11,7 @@ jobs:
         os:
           - ubuntu-latest
           - windows-latest
+          - macos-latest
         python-version:
           - "3.10"
           - "3.11"

CHANGELOG.md

@@ -4,6 +4,17 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
+## [0.0.6] - 2024-02-23
+
+### Fixed
+
+- `to_wkt`for GeometryManager.
+
+### Added
+
+- Add docstring thanks to @piclem.
+- Token support thanks to @luisageo6.
+
 ## [0.0.5] - 2024-02-19
 
 ### Fixed
@@ -176,4 +187,4 @@ really faster faster. Previous behavior is available by selecting `method="stand
 - First public release under the name of earthdaily.
 - module earthdatastore gathers all cube fonctions.
 - earthdatastore.Auth() allows methods for search and datacube creation.
-- Add if missing default scale/offset factor to collection (landsat-c2l2-sr, landsat-c2l2-st, landsat-c2l1).
+- Add if missing default scale/offset factor to collection (landsat-c2l2-sr, landsat-c2l2-st, landsat-c2l1).

README.md

@@ -1,23 +1,97 @@
-# Earthdaily Python Package
+<div id="top"></div>
+<!-- PROJECT SHIELDS -->
+<!--
+*** See the bottom of this document for the declaration of the reference variables
+*** https://www.markdownguide.org/basic-syntax/#reference-style-links
+-->
+
+
+<!-- PROJECT LOGO -->
+<br />
+<p>
+  <h1 >EarthDaily Python Client</h3>
+
+  <p>
+    Your gateway to the Earth Data Store STAC Catalog.
+    <br />
+    <a href="https://earthdailyagro.com/"><strong>Who we are</strong></a>
+    <br />
+    <br />
+    <a href="https://github.com/earthdaily/earthdaily-python-client/">Project description</a>
+    ·
+    <a href="https://github.com/earthdaily/earthdaily-python-client/issues">Report Bug</a>
+    ·
+    <a href="https://github.com/earthdaily/earthdaily-python-client/issues">Request Feature</a>
+  </p>
+</p>
+
+
+<div>
+
 [![PyPI version](https://badge.fury.io/py/earthdaily.png)](https://badge.fury.io/py/earthdaily)
 [![Documentation](https://img.shields.io/badge/Documentation-html-green.svg)](https://earthdaily.github.io/earthdaily-python-client/)
 [![pytest-main](https://github.com/earthdaily/earthdaily-python-client/actions/workflows/pytest-prod.yaml/badge.svg)](https://github.com/earthdaily/earthdaily-python-client/actions/workflows/pytest-prod.yaml)
 
-## Your Gateway to the Stac Catalog Earth Data Store
+</div>
+
+
+<!--[![Stargazers][GitStars-shield]][GitStars-url]-->
+<!--[![Forks][forks-shield]][forks-url]-->
+<!--[![Stargazers][stars-shield]][stars-url]-->
+
+
+<!-- TABLE OF CONTENTS -->
+<details open>
+  <summary>Table of Contents</summary>
+  <ol>
+    <li>
+      <a href="#about-the-project">About The Project</a>
+    </li>
+    <li>
+      <a href="#getting-started">Getting Started</a>
+      <ul>
+        <li><a href="#prerequisites">Prerequisites</a></li>
+        <li><a href="#installation">Installation</a></li>
+      </ul>
+    </li>
+    <li><a href="#usage">Usage</a></li>
+    <li><a href="#support-development">Support development</a></li>
+    <li><a href="#license">License</a></li>
+    <li><a href="#contact">Contact</a></li>
+    <li><a href="#copyrights">Copyrights</a></li>
+  </ol>
+</details>
+
+<!-- ABOUT THE PROJECT -->
+## About The Project
 
 In the realm of geospatial data analysis and Earth observation, the EarthDaily Python package emerges as a powerful toolset that seamlessly connects you to the vast and invaluable Stac catalog Earth Data Store. This package is designed with the vision of simplifying and optimizing your workflow, ensuring that you can harness the full potential of Earth observation data with ease and efficiency.
 
 Our package is built upon a foundation of best practices, meticulously crafted to elevate your data analysis experience. With EarthDaily, you can effortlessly navigate the complexities of datacube creation, including crucial processes like conversion to reflectance and automatic clipping to your area of interest. Additionally, we've taken care to make EarthDaily fully compatible with Dask, enabling you to scale your data preprocessing tasks with confidence and precision.
 
-## Install
 
-### Using pip 
+## Features
+
+See [documentation](https://earthdaily.github.io/earthdaily-python-client/) for more information
+
+## Getting started
+
+### Prerequisites
+
+Make sure you have valid EDS credentials. If you need to get trial access, please contact us.
+
+This package has been tested on Python 3.10, 3.11 and 3.12.
+
+
+### Installation
+
+#### Using pip 
 
 `pip install earthdaily`
 
-### Planned : Using conda/mamba
+#### Planned : Using conda/mamba
 
-## Authentication
+### Authentication
 Authentication credentials are accessed from environment variables. As a convenience python-dotenv is supported. 
 Copy the `.env.sample` file and rename to simply `.env` and update with your credentials. This file is gitignored. 
 Then add to your script/notebook:
@@ -26,4 +100,37 @@ Then add to your script/notebook:
 from dotenv import load_dotenv
 
 load_dotenv()  # take environment variables from .env.
-```
+```
+
+### Usage
+
+See the documentation for more information.
+
+### Support development
+
+If you find this package useful, please consider supporting its development.
+
+<!-- CONTRIBUTING -->
+## Support development
+
+If this project has been useful, that it helped you or your business to save precious time, don't hesitate to give it a star.
+
+<p align="right">(<a href="#top">back to top</a>)</p>
+
+## License
+
+Distributed under the MIT License. 
+
+<p align="right">(<a href="#top">back to top</a>)</p>
+
+## Contact
+
+For any additonal information, please [email us](mailto:[email protected]).
+
+<p align="right">(<a href="#top">back to top</a>)</p>
+
+## Copyrights
+
+© EarthDaily | All Rights Reserved.
+
+<p align="right">(<a href="#top">back to top</a>)</p>

docs/api.rst

@@ -1,8 +1,10 @@
 API Reference
 =============
 
-.. toctree::
-   :maxdepth: 3
+.. autosummary::
+   :toctree: generated
    :caption: Documentation API
+   :template: custom-module-template.rst
+   :recursive:
 
    earthdaily

docs/conf.py

@@ -34,7 +34,9 @@
     "sphinx_automodapi.automodapi",  # for a page per function
     "myst_parser",
     "rst2pdf.pdfbuilder",
+    "sphinx_immaterial"
 ]
+
 #
 automodapi_toctreedirnm = "_API"
 numpydoc_show_class_members = False
@@ -99,7 +101,20 @@
 # a list of builtin themes.
 #
 # html_theme = 'alabaster'
-html_theme = "sphinx_rtd_theme"
+# html_theme = "sphinx_rtd_theme"
+html_theme = "sphinx_immaterial"
+
+html_theme_options = {
+
+    "repo_url": "https://github.com/GEOSYS/earthdaily-client-python",
+    "repo_name": "GEOSYS/earthdaily",
+    "palette": { 
+        "scheme": "default",
+        "palette": { 
+            "primary": "cyan",
+            "accent": "green"  }
+        }
+}
 
 source_suffix = [".rst", ".md"]
 

docs/index.rst

@@ -21,9 +21,11 @@ earthdaily documentation
 
 
 .. toctree::
-   :maxdepth: 3
+   :maxdepth: 1
+   :caption: Getting Started
 
    self
+   _auto_examples/first_steps_create_datacube
 
 .. toctree::
    :maxdepth: 3
@@ -35,7 +37,7 @@ earthdaily documentation
    :maxdepth: 3
    :caption: Documentation API
 
-   earthdaily
+   api
    CONTRIBUTING
    CHANGELOG
 

earthdaily/__init__.py

@@ -1,3 +1,3 @@
 from . import earthdatastore, datasets
 
-__version__ = "0.0.5"
+__version__ = "0.0.6"