coco_pipe.report.config
=======================

.. py:module:: coco_pipe.report.config

.. autoapi-nested-parse::

   Configuration Schemas for Report
   ================================

   Pydantic models for validating report configuration and metadata.

   Classes
   -------
   ProvenanceConfig
       Capture environment and execution metadata.
   ReportConfig
       Main configuration for the report generation.

   Author: Hamza Abdelhedi (hamza.abdelhedi@umontreal.ca)



Classes
-------

.. autoapisummary::

   coco_pipe.report.config.ProvenanceConfig
   coco_pipe.report.config.ReportConfig


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

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

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


   Configuration for execution provenance.


   .. py:attribute:: model_config

      Configuration for the model, should be a dictionary conforming to [`ConfigDict`][pydantic.config.ConfigDict].


   .. py:attribute:: source
      :type:  str
      :value: None



   .. py:attribute:: git_hash
      :type:  str
      :value: None



   .. py:attribute:: timestamp_utc
      :type:  str
      :value: None



   .. py:attribute:: command
      :type:  Optional[str]
      :value: None



   .. py:attribute:: python_version
      :type:  Optional[str]
      :value: None



   .. py:attribute:: os_platform
      :type:  Optional[str]
      :value: None



   .. py:attribute:: versions
      :type:  Dict[str, str]
      :value: None



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

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


   Configuration for the Report object.


   .. py:attribute:: model_config

      Configuration for the model, should be a dictionary conforming to [`ConfigDict`][pydantic.config.ConfigDict].


   .. py:attribute:: title
      :type:  str
      :value: None



   .. py:attribute:: author
      :type:  Optional[str]
      :value: None



   .. py:attribute:: description
      :type:  Optional[str]
      :value: None



   .. py:attribute:: provenance
      :type:  Optional[ProvenanceConfig]
      :value: None



   .. py:attribute:: run_params
      :type:  Dict[str, Any]
      :value: None