basic readme and docs

.github/workflows/python-package.yml

@@ -60,4 +60,16 @@ jobs:
           CDSE_S3_ACCESS_KEY: ${{ secrets.CDSE_S3_ACCESS_KEY }}
           CDSE_S3_ACCESS_SECRET: ${{ secrets.CDSE_S3_ACCESS_SECRET }}
           CURL_CA_BUNDLE: /etc/ssl/certs/ca-certificates.crt
-        run: pytest -v --cov mapchete-eo --cov-report xml:coverage.xml --cov-report=term-missing:skip-covered
+        run: pytest -v --cov mapchete_eo --cov-report xml:coverage.xml --cov-report=term-missing:skip-covered --junitxml=pytest.xml
+
+      # Upload the report to Codecov
+      - name: Upload coverage reports to Codecov
+        uses: codecov/codecov-action@v5
+        with:
+          token: ${{ secrets.CODECOV_TOKEN }}
+          slug: mapchete/mapchete-eo
+
+      # this will let the workflow fail if coverage is below 100%
+      - name: Pytest coverage
+        run: coverage report --skip-covered --show-missing
+        # --fail-under 100

.gitignore

@@ -11,3 +11,4 @@ dist/
 *.gfs
 .vscode/
 __pycache__
+examples/sentinel-2*/

CHANGELOG.rst

@@ -3,6 +3,12 @@ Changelog
 #########
 
 
+2025.8.0 - 2025-08-07
+----------------------
+
+* add rudimentary example
+* add init docs and readthedocs.yaml for docs build and publish
+
 2025.7.0 - 2025-07-30
 ----------------------
 

README.rst

@@ -0,0 +1,46 @@
+.. image:: logo/mapchete_eo.svg
+
+Earth Observation–specific driver extensions for `Mapchete <https://github.com/ungarj/mapchete>`_.
+
+.. image:: https://img.shields.io/pypi/v/mapchete-eo.svg
+  :target: https://pypi.org/project/mapchete-eo/
+
+.. image:: https://img.shields.io/pypi/l/mapchete-eo.svg
+  :target: https://github.com/mapchete/mapchete-eo/blob/main/LICENSE
+
+.. image:: https://img.shields.io/github/actions/workflow/status/mapchete/mapchete-eo/python-package.yml?label=tests
+  :target: https://github.com/mapchete/mapchete-eo/actions
+
+.. image:: https://codecov.io/gh/mapchete/mapchete-eo/graph/badge.svg?token=VD1YOF3QA2
+  :target: https://codecov.io/gh/mapchete/mapchete-eo
+
+.. image:: https://img.shields.io/github/repo-size/mapchete/mapchete-eo
+  :target: https://github.com/mapchete/mapchete-eo
+
+This package provides custom input and output drivers tailored for common EO data formats and workflows, enabling seamless integration of satellite data sources into the Mapchete tile-based geoprocessing framework.
+
+What is this?
+-------------
+
+**mapchete-eo** extends Mapchete by adding support for:
+
+- Custom **input drivers** to read EO datasets, from STAC search or metadata (catalogs, collections, items)
+- Metadata extraction and band management for optical satellite products
+- Reading data from sources via **STAC assets**
+
+This package is intended for advanced users or developers who are working with remote sensing workflows using Mapchete.
+
+Installation
+------------
+
+You must have ``mapchete`` with ``s3`` installed, so let's grab the ``complete`` dependencies in this case for convenience:
+
+.. code-block:: bash
+
+    pip install mapchete[complete]
+
+Then install mapchete-eo:
+
+.. code-block:: bash
+
+    pip install mapchete-eo