Skip to content

Commit

Permalink
docs: set_configuration
Browse files Browse the repository at this point in the history
  • Loading branch information
srepmub committed Oct 18, 2023
1 parent 8035c41 commit 6e1b6eb
Show file tree
Hide file tree
Showing 3 changed files with 18 additions and 0 deletions.
6 changes: 6 additions & 0 deletions docs/ext_hooks.md
Original file line number Diff line number Diff line change
Expand Up @@ -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).
Expand Down
6 changes: 6 additions & 0 deletions docs/ext_product_types.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down
6 changes: 6 additions & 0 deletions docs/ext_remote.md
Original file line number Diff line number Diff line change
Expand Up @@ -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``.
Expand Down

0 comments on commit 6e1b6eb

Please sign in to comment.