Basic docs structure for RTD

This commit is contained in:
erinhmclark
2025-01-15 21:45:29 +00:00
parent 05e0c9de93
commit d3eec5d90f
38 changed files with 1034 additions and 40 deletions

View File

@@ -1,3 +1,10 @@
""" The `archiver` module defines the base functionality for implementing archivers in the media archiving framework.
This class provides common utility methods and a standard interface for archivers.
Factory method to initialize an archiver instance based on its name.
"""
from __future__ import annotations
from abc import abstractmethod
from dataclasses import dataclass
@@ -11,6 +18,11 @@ from ..core import Metadata, Step, ArchivingContext
@dataclass
class Archiver(Step):
"""
Base class for implementing archivers in the media archiving framework.
Subclasses must implement the `download` method to define platform-specific behavior.
"""
name = "archiver"
def __init__(self, config: dict) -> None:
@@ -66,4 +78,5 @@ class Archiver(Step):
return to_filename
@abstractmethod
def download(self, item: Metadata) -> Metadata: pass
def download(self, item: Metadata) -> Metadata:
pass