hermes.commands.harvest.codemeta
================================

.. py:module:: hermes.commands.harvest.codemeta


Classes
-------

.. autoapisummary::

   hermes.commands.harvest.codemeta.CodeMetaHarvestPlugin


Module Contents
---------------

.. py:class:: CodeMetaHarvestPlugin

   Bases: :py:obj:`hermes.commands.harvest.base.HermesHarvestPlugin`


   Base plugin that does harvesting.

   TODO: describe the harvesting process and how this is mapped to this plugin.


   .. py:method:: __call__(command: hermes.commands.harvest.base.HermesHarvestCommand) -> Tuple[Dict, Dict]

      Implementation of a harvester that provides data from a codemeta.json file format.

      :param path: The working path
      :param config_path: The path to the config TOML file
      :param ctx: The harvesting context that should contain the provided metadata.



   .. py:method:: _validate(codemeta_file: pathlib.Path) -> bool


   .. py:method:: _get_single_codemeta(path: pathlib.Path) -> Optional[pathlib.Path]