generate_report
===============

.. py:module:: generate_report


Attributes
----------

.. autoapisummary::

   generate_report.ENCODING
   generate_report.CONTEXT_FOLDER
   generate_report.TOP_N
   generate_report.TOP_K
   generate_report.VERBOSE_DEFAULT
   generate_report.DATA_FOLDER
   generate_report.ALL_CONTEXT_FILENAME
   generate_report.PARAMS_FILENAME
   generate_report.TEMPLATES_FOLDER
   generate_report.INTRODUCTION_FILENAME
   generate_report.OVERVIEW_FILENAME
   generate_report.ALL_CONTEXT_HEADER_TEMPLATE
   generate_report.ALL_CONTEXT_CONTENT_TEMPLATE
   generate_report.SINGLE_CONTEXT_TEMPLATE
   generate_report.generator


Classes
-------

.. autoapisummary::

   generate_report.ReportGenerator


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

.. py:data:: ENCODING
   :value: 'utf-8'


.. py:data:: CONTEXT_FOLDER
   :value: 'by-context'


.. py:data:: TOP_N
   :value: 10


.. py:data:: TOP_K
   :value: 10


.. py:data:: VERBOSE_DEFAULT
   :value: False


.. py:data:: DATA_FOLDER
   :value: 'aggregated_data'


.. py:data:: ALL_CONTEXT_FILENAME
   :value: 'all_contexts.qmd'


.. py:data:: PARAMS_FILENAME
   :value: 'params.yml'


.. py:data:: TEMPLATES_FOLDER
   :value: './assets/templates'


.. py:data:: INTRODUCTION_FILENAME
   :value: 'getting-started.qmd'


.. py:data:: OVERVIEW_FILENAME
   :value: 'overview.qmd'


.. py:data:: ALL_CONTEXT_HEADER_TEMPLATE
   :value: 'all_context_header.qmd'


.. py:data:: ALL_CONTEXT_CONTENT_TEMPLATE
   :value: 'all_context_content.qmd'


.. py:data:: SINGLE_CONTEXT_TEMPLATE
   :value: 'context.qmd'


.. py:class:: ReportGenerator

   .. py:attribute:: report_folder


   .. py:attribute:: root_dir
      :value: ''



   .. py:attribute:: data_folder
      :value: ''



   .. py:attribute:: top_n
      :value: None



   .. py:attribute:: top_k
      :value: None



   .. py:attribute:: by_context_folder
      :value: 'Uninferable/by-context'



   .. py:attribute:: all_context_filepath
      :value: 'Uninferable/by-context/all_contexts.qmd'



   .. py:method:: _log_params()


   .. py:method:: _read_params()


   .. py:method:: _get_context_string(context_info) -> str
      :staticmethod:



   .. py:method:: _read_template(template_filename: str) -> str
      :staticmethod:


      Read a template file and return its content.



   .. py:method:: _write_single_context_file(filename: str, template: str, context_string: str, context_label: str)


   .. py:method:: _write_header_to_file()


   .. py:method:: _append_content_to_file(template: str, context_string: str, context_label: str, context: dict)


   .. py:method:: _get_unique_contexts()


   .. py:method:: _generate_by_context_qmds()


   .. py:method:: _generate_overview_qmd()


   .. py:method:: _generate_introduction_qmd()


   .. py:method:: run()

      Main method to generate the report files.



.. py:data:: generator