Export Reference

The export module provides functionality to export Archive-It seed data to spreadsheet formats such as CSV and XLSX.

Export to various formats.

export_seed_to_spreadsheet(data, file_dir, file_name, file_format='xlsx')

Export seed data to a spreadsheet file.

Note

Can only use with seed data (returns from e.g., api.get_seeds(), api.get_seed_list(), etc.).

Example

# Get seed data from Archive-It API
seed_data = api.get_seeds(collection_id=12345)

# Export seed data to XLSX file
export_seed_to_spreadsheet(
    data=seed_data,
    file_dir="output",
    file_name="seeds.xlsx",
    file_format="xlsx"
)

Parameters:

Name	Type	Description	Default
data	list of dict	The data to export.	required
file_dir	Path | str	The directory to save the output file.	required
file_name	Path | str	The name of the output file.	required
file_format	str	The format of the output file ('xlsx' or 'csv').	'xlsx'