aim.services module

class aim.services.Services(app_name: str, logger: BoundLogger, mysql_database: URL, test_database: str, ci_on: str | None, alma_api_key: str, alma_api_url: str, digifeeds_set_id: str, digifeeds_api_url: str, zephir_bib_api_url: str, digifeeds_s3_rclone_remote: str, digifeeds_pickup_rclone_remote: str, digifeeds_fileserver_rclone_remote: str, digifeeds_s3_input_path: str, digifeeds_s3_processed_path: str, digifeeds_s3_prunable_path: str, digifeeds_delivery_reports_path: str, digifeeds_hathifiles_reports_path: str, digifeeds_fileserver_prunable_path: str, hathifiles_store_path: str, hathifiles_webhook_url: str, hathifiles_mysql_database: URL, hathifiles_api_url: str)[source]

Bases: object

Global Configuration Services

alma_api_key: str: The Alma API Key

alma_api_url: str: The Alma API url

app_name: str: The application name

ci_on: str | None: Is this being run in Github Actions?

digifeeds_api_url: str: The digifeeds database API URL

digifeeds_delivery_reports_path: str: The path to the directory where we put reports about what has been sent to google

digifeeds_fileserver_prunable_path: str: The path to the directory on the fileserver remote for processed barcodes of new items that are safe to prune when found in hathifiles

digifeeds_fileserver_rclone_remote: str

digifeeds_hathifiles_reports_path: str: The path to the directory where we put reports that show what items are in hathitrust

digifeeds_pickup_rclone_remote: str: The name of the rclone remote for the place where google pickups up the digifeeds files

digifeeds_s3_input_path: str: The url in the s3 bucket for the digifeeds process

digifeeds_s3_processed_path: str: The path in the s3 bucket for processed barcodes

digifeeds_s3_prunable_path: str: The path in the s3 bucket for processed barcodes of new items that are safe to prune when found in hathifiles

digifeeds_s3_rclone_remote: str: The name of the rclone remote/bucket alias for the s3 input bucket

digifeeds_set_id: str: The Alma Set Id for the digifeeds set

hathifiles_api_url: str: The Hathifiles API URL

hathifiles_mysql_database: URL: The Hathifiles MySQL database

hathifiles_store_path: str: file path to store of the hathi_file_list update items

hathifiles_webhook_url: str: url to argo events webhook for triggering the update of the hathifiles database

logger: BoundLogger: The structured logger

mysql_database: URL: The Digifeeds MySQL database

test_database: str: A sqlite in memory digifeeds database for testing

zephir_bib_api_url: str: The zephir item bib api