From 6e1b6eb027e69fd226051d9de81d7b58ff6de664 Mon Sep 17 00:00:00 2001 From: Mark Dufour Date: Wed, 18 Oct 2023 09:00:03 +0200 Subject: [PATCH] docs: set_configuration --- docs/ext_hooks.md | 6 ++++++ docs/ext_product_types.md | 6 ++++++ docs/ext_remote.md | 6 ++++++ 3 files changed, 18 insertions(+) diff --git a/docs/ext_hooks.md b/docs/ext_hooks.md index 550b87e..05d5a4f 100644 --- a/docs/ext_hooks.md +++ b/docs/ext_hooks.md @@ -21,6 +21,12 @@ permalink: /ext_hooks/ All methods described here are optional. When a method changes a product property, it is not automatically saved. +``set_configuration(self, config)`` +> Optionally receives muninn configuration options under the section +> ``[extension:module_name]``, where module_name is the import name/path for +> the extension module. The options are passed as a key-value dictionary, +> containing only strings. + ``post_ingest_hook(self, archive, product, paths)`` > Executed after a product is ingested via archive.ingest, but not > catalogue-only (ingest_product == True). diff --git a/docs/ext_product_types.md b/docs/ext_product_types.md index 4e2cc3d..92a5cef 100644 --- a/docs/ext_product_types.md +++ b/docs/ext_product_types.md @@ -92,6 +92,12 @@ permalink: /ext_product_types/ ## Methods +``set_configuration(self, config)`` +> Optionally receives muninn configuration options under the section +> ``[extension:module_name]``, where module_name is the import name/path for +> the extension module. The options are passed as a key-value dictionary, +> containing only strings. + ``identify(self, paths)`` > Returns ``True`` if the specified list of paths constitutes a product of > the product type the plug-in is designed to handle, ``False`` otherwise. diff --git a/docs/ext_remote.md b/docs/ext_remote.md index f54a7f4..50b7289 100644 --- a/docs/ext_remote.md +++ b/docs/ext_remote.md @@ -19,6 +19,12 @@ permalink: /ext_remote/ ## Methods +``set_configuration(self, config)`` +> Optionally receives muninn configuration options under the section +> ``[extension:module_name]``, where module_name is the import name/path for +> the extension module. The options are passed as a key-value dictionary, +> containing only strings. + ``pull(self, archive, product, target_path)`` > Download the product specified. > The product should be downloaded in the path indicated by ``target_path``.