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

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

.. autoapi-nested-parse::

   Pydantic schemas for report configuration and provenance metadata.



Classes
-------

.. autoapisummary::

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


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

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

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


   Runtime provenance attached to generated reports.


   .. 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:  str | None
      :value: None



   .. py:attribute:: python_version
      :type:  str | None
      :value: None



   .. py:attribute:: os_platform
      :type:  str | None
      :value: None



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



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



   .. py:method:: from_env(source = 'Unknown', **kwargs)
      :classmethod:


      Build a ProvenanceConfig by capturing the current runtime environment.

      :param source: Description of the data source.
      :type source: str
      :param \*\*kwargs: Additional metadata to override or append to the environment info.
      :type \*\*kwargs: Any

      :returns: A new instance populated with runtime metrics.
      :rtype: ProvenanceConfig



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

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


   User-facing configuration attached to a report.


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



   .. py:attribute:: author
      :type:  str | None
      :value: None



   .. py:attribute:: description
      :type:  str | None
      :value: None



   .. py:attribute:: provenance
      :type:  ProvenanceConfig
      :value: None



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