html_formatter
==============

.. py:module:: html_formatter


Submodules
----------

.. toctree::
   :maxdepth: 1

   /autoapi/html_formatter/html_formatter/index
   /autoapi/html_formatter/templates/index




Package Contents
----------------

.. py:class:: HtmlFormatter

   Bases: :py:obj:`auto_archiver.core.Formatter`


   Base class for implementing formatters in the media archiving framework.

   Subclasses must implement the `format` method to define their behavior.


   .. py:attribute:: environment
      :type:  jinja2.Environment
      :value: None



   .. py:attribute:: template
      :type:  any
      :value: None



   .. py:method:: setup() -> None

      Sets up the Jinja2 environment and loads the template.



   .. py:method:: format(item: auto_archiver.core.Metadata) -> auto_archiver.core.Media

      Formats a Metadata object into a user-viewable format (e.g. HTML) and stores it if needed.