core.formatter

Base module for formatters – modular components that format metadata into media objects for storage.

The most commonly used formatter is the HTML formatter, which takes metadata and formats it into an HTML file for storage.

Module Contents

class core.formatter.Formatter

Bases: auto_archiver.core.BaseModule

Base class for implementing formatters in the media archiving framework.

Subclasses must implement the format method to define their behavior.

abstract 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.