gsheet_feeder_db.gsheet_feeder_db

gsheet_feeder_db.gsheet_feeder_db#

GsheetsFeeder: A Google Sheets-based feeder for the Auto Archiver.

This reads data from Google Sheets and filters rows based on user-defined rules. The filtered rows are processed into Metadata objects.

### Key properties - validates the sheet’s structure and filters rows based on input configurations. - Ensures only rows with valid URLs and unprocessed statuses are included.

Module Contents#

class gsheet_feeder_db.gsheet_feeder_db.GsheetsFeederDB#

Bases: auto_archiver.core.Feeder, auto_archiver.core.Database

Base class for implementing feeders in the media archiving framework.

Subclasses must implement the __iter__ method to define platform-specific behavior.

setup() → None#
open_sheet() → gspread.Spreadsheet#
enumerate_sheets(sheet) → Iterator[gspread.Worksheet]#
should_process_sheet(sheet_name: str) → bool#
missing_required_columns(gw: auto_archiver.modules.gsheet_feeder_db.GWorksheet) → list#
started(item: auto_archiver.core.Metadata) → None#

signals the DB that the given item archival has started

failed(item: auto_archiver.core.Metadata, reason: str) → None#

update DB accordingly for failure

aborted(item: auto_archiver.core.Metadata) → None#

abort notification if user cancelled after start

fetch(item: auto_archiver.core.Metadata) → auto_archiver.core.Metadata | bool#

check if the given item has been archived already

done(item: auto_archiver.core.Metadata, cached: bool = False) → None#

archival result ready - should be saved to DB

Contents