mirror of
https://github.com/bellingcat/auto-archiver.git
synced 2026-06-12 05:08:28 +03:00
72 lines
2.9 KiB
Python
72 lines
2.9 KiB
Python
{
|
|
"name": "Google Sheets Feeder",
|
|
"type": ["feeder"],
|
|
"entry_point": "gsheet_feeder::GsheetsFeeder",
|
|
"requires_setup": True,
|
|
"external_dependencies": {
|
|
"python": ["loguru", "gspread", "python-slugify"],
|
|
},
|
|
"configs": {
|
|
"sheet": {"default": None, "help": "name of the sheet to archive"},
|
|
"sheet_id": {
|
|
"default": None,
|
|
"help": "(alternative to sheet name) the id of the sheet to archive",
|
|
},
|
|
"header": {"default": 1, "help": "index of the header row (starts at 1)", "type": "int"},
|
|
"service_account": {
|
|
"default": "secrets/service_account.json",
|
|
"help": "service account JSON file path",
|
|
},
|
|
"columns": {
|
|
"default": {
|
|
"url": "link",
|
|
"status": "archive status",
|
|
"folder": "destination folder",
|
|
"archive": "archive location",
|
|
"date": "archive date",
|
|
"thumbnail": "thumbnail",
|
|
"timestamp": "upload timestamp",
|
|
"title": "upload title",
|
|
"text": "text content",
|
|
"screenshot": "screenshot",
|
|
"hash": "hash",
|
|
"pdq_hash": "perceptual hashes",
|
|
"wacz": "wacz",
|
|
"replaywebpage": "replaywebpage",
|
|
},
|
|
"help": "names of columns in the google sheet (stringified JSON object)",
|
|
"type": "auto_archiver.utils.json_loader",
|
|
},
|
|
"allow_worksheets": {
|
|
"default": set(),
|
|
"help": "(CSV) only worksheets whose name is included in allow are included (overrides worksheet_block), leave empty so all are allowed",
|
|
},
|
|
"block_worksheets": {
|
|
"default": set(),
|
|
"help": "(CSV) explicitly block some worksheets from being processed",
|
|
},
|
|
"use_sheet_names_in_stored_paths": {
|
|
"default": True,
|
|
"help": "if True the stored files path will include 'workbook_name/worksheet_name/...'",
|
|
"type": "bool",
|
|
},
|
|
},
|
|
"description": """
|
|
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.
|
|
|
|
### Features
|
|
- Validates the sheet structure and filters rows based on input configurations.
|
|
- Processes only worksheets allowed by the `allow_worksheets` and `block_worksheets` configurations.
|
|
- Ensures only rows with valid URLs and unprocessed statuses are included for archival.
|
|
- Supports organizing stored files into folder paths based on sheet and worksheet names.
|
|
|
|
### Notes
|
|
- Requires a Google Service Account JSON file for authentication. Suggested location is `secrets/gsheets_service_account.json`.
|
|
- Create the sheet using the template provided in the docs.
|
|
""",
|
|
}
|