earthcode 0.1.8__tar.gz → 0.1.9__tar.gz

{earthcode-0.1.8 → earthcode-0.1.9}/.github/workflows/ci.yml

@@ -25,23 +25,25 @@ jobs:
 
     steps:
       - name: Checkout earthcode-library
-        uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # v6
+        uses: actions/checkout@d23441a48e516b6c34aea4fa41551a30e30af803 # v6.1.0
         with:
           path: earthcode-library
+          persist-credentials: false
 
       - name: Checkout open-science-catalog-metadata
-        uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # v6
+        uses: actions/checkout@d23441a48e516b6c34aea4fa41551a30e30af803 # v6.1.0
         with:
           repository: ESA-EarthCODE/open-science-catalog-metadata
           path: open-science-catalog-metadata
+          persist-credentials: false
 
-      - name: Install Pixi
-        run: |
-          curl -fsSL https://pixi.sh/install.sh | sh
-          echo "$HOME/.pixi/bin" >> "$GITHUB_PATH"
-
-      - name: Install dependencies
-        run: pixi install --locked
+      - name: Set up Pixi
+        uses: prefix-dev/setup-pixi@ad1da6449d9e506fd127fd67ab2d054a769f6a94 # v0.11.2
+        with:
+          pixi-version: v0.82.1
+          working-directory: earthcode-library
+          locked: true
+          cache: true
 
       - name: Run test suite
-        run: pixi run -e default pytest
+        run: pixi run --locked -e default pytest

{earthcode-0.1.8 → earthcode-0.1.9}/.github/workflows/pages.yml

@@ -29,8 +29,6 @@ on:
 
 permissions:
   contents: read
-  pages: write
-  id-token: write
 
 concurrency:
   group: pages
@@ -43,19 +41,19 @@ jobs:
 
     steps:
       - name: Checkout repository
-        uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # v6
-
-      - name: Set up Python
-        uses: actions/setup-python@a26af69be951a213d495a4c3e4e4022e16d87065 # v5
+        uses: actions/checkout@d23441a48e516b6c34aea4fa41551a30e30af803 # v6.1.0
         with:
-          python-version: "3.12"
-          cache: pip
+          persist-credentials: false
 
-      - name: Install Jupyter Book
-        run: python -m pip install --upgrade "jupyter-book>=1.0.4,<2"
+      - name: Set up Pixi
+        uses: prefix-dev/setup-pixi@ad1da6449d9e506fd127fd67ab2d054a769f6a94 # v0.11.2
+        with:
+          pixi-version: v0.82.1
+          locked: true
+          cache: true
 
       - name: Build site
-        run: jupyter-book build .
+        run: pixi run --locked docs
 
       - name: Upload Pages artifact
         uses: actions/upload-pages-artifact@56afc609e74202658d3ffba0e8f6dda462b719fa # v3
@@ -67,6 +65,9 @@ jobs:
     if: github.event_name == 'push' && github.ref == 'refs/heads/main'
     needs: build
     runs-on: ubuntu-latest
+    permissions:
+      pages: write
+      id-token: write
     environment:
       name: github-pages
       url: ${{ steps.deployment.outputs.page_url }}

{earthcode-0.1.8 → earthcode-0.1.9}/.github/workflows/publish.yml

@@ -20,23 +20,22 @@ jobs:
 
     steps:
       - name: Checkout repository
-        uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # v6
+        uses: actions/checkout@d23441a48e516b6c34aea4fa41551a30e30af803 # v6.1.0
         with:
           persist-credentials: false
 
-      - name: Set up Python
-        uses: actions/setup-python@a309ff8b426b58ec0e2a45f0f869d46889d02405 # v6
+      - name: Set up Pixi
+        uses: prefix-dev/setup-pixi@ad1da6449d9e506fd127fd67ab2d054a769f6a94 # v0.11.2
         with:
-          python-version: "3.12"
-
-      - name: Install build tools
-        run: python -m pip install --upgrade build twine
+          pixi-version: v0.82.1
+          locked: true
+          cache: true
 
       - name: Build distribution artifacts
-        run: python -m build
+        run: pixi run --locked python -m build --no-isolation
 
       - name: Check distribution metadata
-        run: python -m twine check dist/*
+        run: pixi run --locked python -m twine check dist/*
 
       - name: Upload distribution artifacts
         uses: actions/upload-artifact@330a01c490aca151604b8cf639adc76d48f6c5d4 # v5
@@ -65,4 +64,4 @@ jobs:
           path: dist/
 
       - name: Publish to PyPI
-        uses: pypa/gh-action-pypi-publish@ed0c53931b1dc9bd32cbe73a98c7f6766f8a527e # release/v1
+        uses: pypa/gh-action-pypi-publish@7245906fb61fa33a13554f9d5fb856fe61758086 # v1.14.3

earthcode-0.1.9/.gitignore

@@ -0,0 +1,23 @@
+
+# pixi environments
+.pixi
+.idea
+*.egg-info
+*__pycache__*
+*.json
+test*.ipynb
+open-science-catalog-metadata
+htmlcov/
+*.coverage
+_build/
+dist/
+dev.ipynb
+earthcode/models
+guide/project.yaml
+guide/.ipynb_checkpoints/
+guide/product.yaml
+earthcode/generators/project_generator.py
+guide/workflow.yaml
+guide/experiment.yaml
+docs/examples/downloaded_data/
+*.ipynb_checkpoints/

{earthcode-0.1.8 → earthcode-0.1.9}/PKG-INFO

@@ -1,6 +1,6 @@
-Metadata-Version: 2.4
+Metadata-Version: 2.5
 Name: earthcode
-Version: 0.1.8
+Version: 0.1.9
 Summary: Tools for creating, validating, and searching EarthCODE Open Science Catalog metadata.
 Project-URL: Homepage, https://github.com/ESA-EarthCODE/earthcode-library
 Project-URL: Repository, https://github.com/ESA-EarthCODE/earthcode-library
@@ -18,6 +18,7 @@ Classifier: Programming Language :: Python :: 3.13
 Classifier: Topic :: Scientific/Engineering
 Requires-Python: >=3.12
 Requires-Dist: bottleneck<2,>=1.6.0
+Requires-Dist: certifi>=2026.10.19
 Requires-Dist: dask<2026,>=2025.12.0
 Requires-Dist: fsspec<2026,>=2025.10.0
 Requires-Dist: geopandas<2,>=1.1.2
@@ -49,32 +50,55 @@ Requires-Dist: pytest<10,>=9.0.2; extra == 'dev'
 Description-Content-Type: text/markdown
 
 # Introduction
-
+The EarthCODE Library is a Python package developed to support the creation, validation, and search of Open Science Catalog metadata within the EarthCODE publishing workflow. It provides a shared implementation layer for catalog-related operations, reducing the need for project teams and platforms to maintain separate, ad hoc approaches for generating and checking metadata. This repository includes the core package, a command-line interface, usage examples, publication guides, and a test suite, 
 This repository provides Python tools for creating, validating, and searching EarthCODE [Open Science Catalog metadata](https://opensciencedata.esa.int/).
 
+Documentation on usage and guides is maintained at: https://esa-earthcode.github.io/earthcode-library/README.html 
 
-## Installation
+## 1. Installation
 ```bash
 pip install earthcode
 ```
+### Requirements
+The *minimum* required Python version if you would like to install the library locally is 3.12
+
 
-## Publishing to the Open Science catalog
+## 2. Quick start
+```bash
+# 1. Import the library
+import earthcode
 
-In the `guide/` folder you can find instructions how to publish your results to the Open Science Catalog.
-Start with the `guide/0.Prerequisites - local.ipynb` notebook if you are running the examples locally.
-Alternatively, start with `guide/0.Prerequisites-EarthCODE-Workspaces.ipynb` if you are using the EarthCODE workspace.
+# 2. Search through the catalog
+from earthcode.search import search
 
+# 3. Search through semantix text
+# Here we take as an example the search done by semantix text and search the catalog via the collection.id which is known
+search(collection_ids="seasfire-cube")[0]
+
+# 4. Filter the products in the catalog
+search("global chlorophyll dataset", variable=chlorophyll.id, type="products", mission="sentinel-3")
+```
 
-## Examples
-In the examples folder you can find notebooks that show:
+## 3. How to contribute to Open Science Catalogue? 
+With `earthcode` library creating new entries in the catalogue is semi-automatic. Please find step by step instructions in the `docs/` folder.
+Start by going through the `docs/contributing_to_the_osc` document.
+
+## 4. Search through Open Science Catalogue
+In the `examples/` folder you can find notebooks that show:
 - How to use the library to semantically search the Open Science Catalog - `examples/earthcode_data_discovery.ipynb`
-- (Experimental) How to combine the library and the OSC editor - `examples/contribute_via_osc_editor.ipynb`
-- How to validate a local copy of the catalog and open a PR - `examples/contribute_via_pr_osc.ipynb`
 
+# Looking for support? 
+We are ready to assist you in case you have any questions/found a bug or mistake, please use GitHub Issues to open a ticket!  
+Alternatively contact the team via e-mail: earthcode@esa.int 
+
+If you would like to request a specific feature, or any question to the community of Earthcode and library developers, please use the [EarthCODE discourse Technical Support channel](https://discourse-earthcode.eox.at/c/technical-support/8) 
 
-# For Developers:
+## Development 
 
-## Local install
+If you want to contribute a feature to the library you are welcome to contribute via pull request.
+First, fork this repository; then make your suggested change and open a PR against this repo. Make sure to add tests for any new functionality.
+
+### Local  install
 1. `git clone https://github.com/ESA-EarthCODE/earthcode-library.git`
 2. Install pixi - https://pixi.sh/dev/installation/
 3. `cd earthcode-library`
@@ -83,9 +107,8 @@ In the examples folder you can find notebooks that show:
 
 You can run tests through `pixi run pytest`. If running on Windows use ` pixi run pytest --basetemp=C:\t` to avoid long path errors, since some of the project names are >260 chars.
 
-## To create a new release and publish it
-
-edit pyproject.toml to 1.1.4 and run
+## To publish a realease
+Edit pyproject.toml to 1.1.4 and run
 
 - `pixi lock`
 - `git add pyproject.toml pixi.toml pixi.lock`

earthcode-0.1.9/README.md

@@ -0,0 +1,67 @@
+# Introduction
+The EarthCODE Library is a Python package developed to support the creation, validation, and search of Open Science Catalog metadata within the EarthCODE publishing workflow. It provides a shared implementation layer for catalog-related operations, reducing the need for project teams and platforms to maintain separate, ad hoc approaches for generating and checking metadata. This repository includes the core package, a command-line interface, usage examples, publication guides, and a test suite, 
+This repository provides Python tools for creating, validating, and searching EarthCODE [Open Science Catalog metadata](https://opensciencedata.esa.int/).
+
+Documentation on usage and guides is maintained at: https://esa-earthcode.github.io/earthcode-library/README.html 
+
+## 1. Installation
+```bash
+pip install earthcode
+```
+### Requirements
+The *minimum* required Python version if you would like to install the library locally is 3.12
+
+
+## 2. Quick start
+```bash
+# 1. Import the library
+import earthcode
+
+# 2. Search through the catalog
+from earthcode.search import search
+
+# 3. Search through semantix text
+# Here we take as an example the search done by semantix text and search the catalog via the collection.id which is known
+search(collection_ids="seasfire-cube")[0]
+
+# 4. Filter the products in the catalog
+search("global chlorophyll dataset", variable=chlorophyll.id, type="products", mission="sentinel-3")
+```
+
+## 3. How to contribute to Open Science Catalogue? 
+With `earthcode` library creating new entries in the catalogue is semi-automatic. Please find step by step instructions in the `docs/` folder.
+Start by going through the `docs/contributing_to_the_osc` document.
+
+## 4. Search through Open Science Catalogue
+In the `examples/` folder you can find notebooks that show:
+- How to use the library to semantically search the Open Science Catalog - `examples/earthcode_data_discovery.ipynb`
+
+# Looking for support? 
+We are ready to assist you in case you have any questions/found a bug or mistake, please use GitHub Issues to open a ticket!  
+Alternatively contact the team via e-mail: earthcode@esa.int 
+
+If you would like to request a specific feature, or any question to the community of Earthcode and library developers, please use the [EarthCODE discourse Technical Support channel](https://discourse-earthcode.eox.at/c/technical-support/8) 
+
+## Development 
+
+If you want to contribute a feature to the library you are welcome to contribute via pull request.
+First, fork this repository; then make your suggested change and open a PR against this repo. Make sure to add tests for any new functionality.
+
+### Local  install
+1. `git clone https://github.com/ESA-EarthCODE/earthcode-library.git`
+2. Install pixi - https://pixi.sh/dev/installation/
+3. `cd earthcode-library`
+4. `pixi install`
+5. `pixi run jupyter lab`
+
+You can run tests through `pixi run pytest`. If running on Windows use ` pixi run pytest --basetemp=C:\t` to avoid long path errors, since some of the project names are >260 chars.
+
+## To publish a realease
+Edit pyproject.toml to 1.1.4 and run
+
+- `pixi lock`
+- `git add pyproject.toml pixi.toml pixi.lock`
+- `git commit -m "Release v1.1.4"`
+- `git push origin main`
+- `git tag -a v1.1.4 -m "Release v1.1.4"`
+- `git push origin v1.1.4`

earthcode-0.1.9/_toc.yml

@@ -0,0 +1,21 @@
+format: jb-book
+root: docs/contributing_to_the_osc.md
+parts:
+  - caption: Tutorials
+    chapters:
+      - file: docs/tutorials/earthcode_data_discovery
+      - file: docs/tutorials/end_to_end_subglacial_lakes
+      - file: docs/tutorials/create_osc_entry_from_prr
+      - file: docs/tutorials/cog_file_metadata_creation
+      - file: docs/tutorials/zarr_file_metadata
+      - file: docs/tutorials/parquet_file_metadata
+  - caption: Guides
+    chapters:
+      - file: docs/guides/0.Prerequisites-EarthCODE-Workspaces
+      - file: docs/guides/0.Prerequisites-local
+      - file: docs/guides/1.Project
+      - file: docs/guides/2.0.Product
+      - file: docs/guides/3.Workflow
+      - file: docs/guides/4.Experiment
+      - file: docs/guides/5.Templates
+      - file: docs/fairtool