feat: added typer entrypoint pluggability

Author: jankovicgd

.gitignore

@@ -54,3 +54,5 @@ MANIFEST
 # Per-project virtualenvs
 .venv*/
 .conda*/
+
+eodm_plugin/

docs/plugins.md

@@ -0,0 +1,56 @@
+# Plugins
+
+`eodm` offers an option to add plugins as there is a wide array of extract, transform,
+load functions in EO that are possible. Below is a minimal transform example
+example.
+
+`pyproject.toml`
+
+```toml
+[project]
+name = "eodm_plugin"
+version = "0.0.0"
+dependencies = [
+    "eodm"
+]
+
+[project.entry-points.'eodm.plugins'] # the entry-point group is the `eodm.plugins`
+transform = 'plugins:app' # the plugin finds `extract`, `transform` or `load` entry points with the name `app` in the package `plugins`
+```
+
+`eodm_plugin/plugins.py`
+
+```python
+import typer
+
+app = typer.Typer(name="plugin", no_args_is_help=True)
+
+
+@app.command()
+def test():
+    print("This is a plugin")
+```
+
+The application gets extended with the group called `plugin` (same as the typer app name)
+and a single command `test`:
+
+```shell
+eodm transform plugin test
+```
+
+The plugin should probaly work by accepting and outputting STAC items, in order to create
+a full pipeline.
+
+## Docker
+
+In addition to creating the plugin, you may need a custom docker image. In that case simply
+extend the existing docker image and install your plugin.
+
+```Dockerfile
+FROM ghcr.io/geopython/eodm
+
+WORKDIR /app
+COPY . .
+
+RUN pip3 install .
+```

mkdocs.yml

@@ -3,6 +3,7 @@ site_name: eodm - EO Data Mover
 nav:
   - Home: index.md
   - Examples: examples.md
+  - Plugins: plugins.md
   - CLI: cli.md
   - API: api.md
 

poetry.lock

@@ -15,13 +15,11 @@ fsspec = "^2024.3.1"
 s3fs = "^2024.3.1"
 pystac = "^1.10.0"
 pystac-client = "^0.7.7"
-odc-stac = "^0.3.9"
-rioxarray = "^0.15.5"
-rio-cogeo = "^5.3.0"
-rio-stac = "^0.9.0"
 python-dateutil = "^2.9.0.post0"
 lxml = "^5.3.0"
 geojson-pydantic = "^1.1.2"
+rio-stac = "^0.10.1"
+rasterio = "^1.4.3"
 
 
 [tool.poetry.group.dev.dependencies]
@@ -50,6 +48,7 @@ version_scheme = "semver"
 version_provider = "poetry"
 update_changelog_on_bump = true
 major_version_zero = true
+
 [build-system]
 requires = ["poetry-core"]
 build-backend = "poetry.core.masonry.api"

pyproject.toml

@@ -1,17 +1,45 @@
-import pkg_resources
+import importlib
+import importlib.metadata
+import sys
+
 import typer
 from dotenv import load_dotenv
 
 from .cli.extract import app as extract
 from .cli.load import app as load
 from .cli.transform import app as transform
 
+if sys.version_info < (3, 10):
+    from importlib_metadata import entry_points
+else:
+    from importlib.metadata import entry_points
+
+discovered_plugins = entry_points(group="eodm.plugins")
 CLI_NAME = "eodm"
 
 app = typer.Typer(name=CLI_NAME, no_args_is_help=True)
+
+try:
+    extract_plugins = discovered_plugins["extract"].load()
+    extract.add_typer(extract_plugins)
+except KeyError:
+    pass
 app.add_typer(extract)
+
+try:
+    transform_plugins = discovered_plugins["transform"].load()
+    transform.add_typer(transform_plugins)
+except KeyError:
+    pass
 app.add_typer(transform)
+
+try:
+    load_plugins = discovered_plugins["load"].load()
+    load.add_typer(load_plugins)
+except KeyError:
+    pass
 app.add_typer(load)
+
 load_dotenv()
 
 
@@ -20,7 +48,7 @@ def version():
     """
     Prints software version
     """
-    version = pkg_resources.get_distribution(CLI_NAME).version
+    version = version = importlib.metadata.version("eodm")
     print(version)
 
 

src/eodm/__main__.py

@@ -1,6 +1,5 @@
 import typer
 
-from .apps.data import app as data
 from .apps.metadata import app as metadata
 
 app = typer.Typer(
@@ -9,5 +8,4 @@
     help="Commands for data and metadata transformations",
 )
 
-app.add_typer(data, name="data", help="Commands for data transformations")
 app.add_typer(metadata, name="metadata", help="Commands for metadata transformations")