this project is meant to facilitate collecting and processing Counter 5 usage data using the SUSHI API across multiple independent vendors. The output for this process is an aggregated dataset consisting of usage data from all identified viable vendors. This dataset can then be used as a singular source for further analysis of the health of our digital collections, to aid in collection assessment and to provide a consistent source for use based data visualizations.
to start using the SushiBuffet script
- download the git repository
- open vendorTemplate.json
- "Save As" or rename as vendor.json (or replace 'vendor.json' on line 119 in sushiBuffet.py with 'vendorTemplate.json')
- open 'vendor.json' and enter in your vendor name, Requestor_id, customer_id, and api_key if applicable, this will give the program information to build the call string when its run.
- save your vendor.json document
- in sushiBuffet.py file lines 114, 115, and 116 represent the report type your calling for, the report start date and the report end date. adjust this in accordance with what report and period you are looking for.
- save sushiBuffet.py file
- run sushiBuffet.py as you would (either in IED or as a CLI)