release(v0.4.0)

release(v0.4.0)

.gitignore

@@ -12,7 +12,6 @@ __pycache__/
 
 # Distribution / packaging
 .Python
-env/
 build/
 develop-eggs/
 dist/
@@ -28,6 +27,15 @@ var/
 .installed.cfg
 *.egg
 
+# Environments
+.env
+.venv
+env/
+venv/
+ENV/
+env.bak/
+venv.bak/
+
 # PyInstaller
 #  Usually these files are written by a python script from a template
 #  before PyInstaller builds the exe, so as to inject date/other infos into it.
@@ -64,7 +72,6 @@ docs/_*
 target/
 
 # Auth
-.env
 .vscode/
 
 docs/html/.doctrees/

docs/API.rst.automodapi

@@ -0,0 +1,16 @@
+API Reference
+=============
+
+
+earthdaily Package
+------------------
+
+.. automodule:: earthdaily
+
+Functions
+^^^^^^^^^
+
+.. automodsumm:: earthdaily
+    :functions-only:
+    :toctree: api
+

docs/CHANGELOG.md

@@ -4,6 +4,25 @@ 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.4.0] - 2025-02-03
+
+### Added
+
+- `native` cloudmask is now supported for `sentinel-2-c1-l2a`.
+- `asset_proxy` has been implemented by @imanshafiei540, see https://github.com/earthdaily/earthdaily-python-client/issues/142
+
+### Changed
+
+- After benchmark, default `chunks` size is `dict(x=512,y=512, time=1)` and 
+not "auto" for x and y anymore.
+- `odc-stac` newest version is now supported (and fix for odc-stac has 
+been submitted).
+
+### Fixed
+
+- Issue in rescale when several datetime were identical #146.
+- Bring back the API section for the documentation #140.
+
 ## [0.3.4] - 2024-12-17
 
 ### Fixed
@@ -21,7 +40,8 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ### Changed
 
-- xarray accessor classes are now privates to avoid having them in autocomplementation.
+- xarray accessor classes are now privates to avoid having them in 
+autocomplementation.
 
 ## [0.3.2] - 2024-12-10
 

docs/api.rst

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

docs/api/earthdaily.EarthDataStore.rst

@@ -0,0 +1,6 @@
+EarthDataStore
+==============
+
+.. currentmodule:: earthdaily
+
+.. autofunction:: EarthDataStore

docs/conf.py

@@ -24,19 +24,21 @@
 
 
 extensions = [
-    "sphinx.ext.autodoc",
+    'sphinx.ext.autodoc',  # For automatic API documentation
+    'sphinx.ext.napoleon',  # For Google/NumPy style docstrings
+    'sphinx.ext.viewcode',  # To add links to source code
+    'sphinx_autodoc_typehints',  # For better type hint support
     "sphinx.ext.autosummary",
     "sphinx.ext.viewcode",
-    "sphinx.ext.napoleon",
-    #"nbsphinx",
     "sphinx_gallery.gen_gallery",
     "sphinx_copybutton",
-    "sphinx_automodapi.automodapi",  # for a page per function
+    "sphinx_automodapi.automodapi",
+    "sphinx_automodapi.smart_resolver",# for a page per function
     "myst_parser",
-    # "sphinxawesome.deprecated"
 ]
 #
-automodapi_toctreedirnm = "_API"
+automodapi_writereprocessed = True
+automodsumm_inherited_members = True
 numpydoc_show_class_members = False
 sys.path.insert(0, os.path.abspath("."))
 sys.path.insert(0, os.path.abspath(".."))

docs/index.rst

@@ -34,15 +34,13 @@ earthdaily documentation
 .. toctree::
    :maxdepth: 3
    :caption: Documentation API
-
-   earthdaily
+   
+   API
    AUTHENTICATION
    CONTRIBUTING
    CHANGELOG
 
 
-
-
 Indices and tables
 ==================
 

docs/templates/custom-module-template.rst

@@ -16,21 +16,21 @@
 
    {% block functions %}
    {% if functions %}
-   .. rubric:: {{ _('Functions alt') }}
-
+   .. rubric:: {{ _('Functions') }}
    .. autosummary::
       :toctree:
       :nosignatures:
    {% for item in functions %}
-   .. autosummary:: {{ item }}
-      :recursive:
-      :template: function.rst
-
-
+      {{ item }}
    {%- endfor %}
+   .. automodule:: {{ fullname }}
+      :members:
+      :exclude-members: {% for item in classes %}{{ item }}, {% endfor %}{% for item in attributes %}{{ item }}, {% endfor %}{% for item in exceptions %}{{ item }}{% endfor %}
+      :undoc-members:
+      :noindex:
    {% endif %}
    {% endblock %}
-
+   
    {% block classes %}
    {% if classes %}
    .. rubric:: {{ _('Classes') }}

earthdaily/__init__.py

@@ -7,15 +7,15 @@
 # to hide warnings from rioxarray or nano seconds conversion
 # warnings.filterwarnings("ignore")
 
-__version__ = "0.3.4"
+__version__ = "0.4.0"
 
 
 def EarthDataStore(
     json_path: Optional[Path] = None,
     toml_path: Optional[Path] = None,
     profile: Optional[str] = None,
     presign_urls: bool = True,
-    request_payer: bool = False,
+    asset_proxy_enabled: bool = False,
 ) -> earthdatastore.Auth:
     """
     Open earth data store connection to allow for datacube requests.
@@ -34,6 +34,10 @@ def EarthDataStore(
     profile : profile, optional
         Name of the profile to use in the TOML file.
         Uses "default" by default.
+    asset_proxy_enabled : bool, optional
+        If True, the asset proxy URLs will be returned instead of pre-signed URLs.
+        Both asset_proxy_enabled and presign_urls cannot be True at the same time. asset_proxy_enabled takes precedence.
+        Uses False by default.
 
     Returns
     -------
@@ -45,5 +49,5 @@ def EarthDataStore(
         toml_path=toml_path,
         profile=profile,
         presign_urls=presign_urls,
-        request_payer=request_payer,
+        asset_proxy_enabled=asset_proxy_enabled,
     )