hermes.commands.harvest.toml
============================

.. py:module:: hermes.commands.harvest.toml

.. autoapi-nested-parse::

   A hermes harvest plugin that harvests the .toml file of the project



Classes
-------

.. autoapisummary::

   hermes.commands.harvest.toml.TomlHarvestSettings
   hermes.commands.harvest.toml.TomlHarvestPlugin


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

.. py:class:: TomlHarvestSettings(/, **data: Any)

   Bases: :py:obj:`pydantic.BaseModel`


   Settings class for this plugin


.. py:class:: TomlHarvestPlugin

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


   Base class for the hermes plugin that harvests .toml files


   .. py:method:: __call__(command: hermes.commands.harvest.base.HermesHarvestCommand) -> hermes.model.api.SoftwareMetadata

      start of the process of harvesting the .toml file



   .. py:method:: read_from_toml(file)
      :classmethod:


      Read and process the data inside the .toml file



   .. py:method:: read_from_one_table(table, mapping)
      :classmethod:


      Read and process the data of one table inside the .toml file



   .. py:method:: handle_different_possibilities_for_persons(persons)
      :classmethod:


      Simplify the data structure of the persons



   .. py:method:: handle_person_in_unknown_format(persons)
      :classmethod:


      Process the persons in the unkown format



   .. py:method:: remove_forbidden_keys(person)
      :classmethod:


      Remove forbidden keys from the person-data-dictionary