A simple Python script to evaluate your ArchivesSpace instance for DACS single-level minimum required elements.
DACSspace utilizes the ArchivesSpace API to check resources for DACS compliance and produces a csv containing a list of evaluated resources. If a DACS field is present its content will be written to the csv, if a field is missing the csv will read "FALSE" for that item.
- Python (written for and tested on 2.7).
- Requests module
If you are using Windows, add Python to your PATH variable
setup.py to create a configuration file named
local_settings.cfg which will allow you to connect to your ArchivesSpace instance. You will need:
- BaseURL of your ArchivesSpace instance
- Repository ID for your ArchivesSpace installation
- ArchivesSpace username and password
Your configuration file will look something like this:
[ArchivesSpace] baseURL: #BaseURL of your ArchivesSpace instance repository: #Repository ID of your ArchivesSpace installation user: #ArchivesSpace username password: #ArchivesSpace password for the username used above [Destinations] directory: #Directory where you would like to save the csv file filename: dacs_singlelevel_report.csv
Using the command line navigate to the directory containing the DACSspace repository and run
single-level.py to execute the script.
DACSspace will prompt you to answer two questions allowing you to limit which resources you'd like the script to evaluate:
Welcome to DACSspace! I'll ask you a series of questions to refine how to script works. If you want to use the default value for a question press the ENTER key. Do you want DACSspace to include unpublished resources? y/n (default is n): Do you want to further limit the script by a specific resource id? If so, enter a string that must be present in the resource id (enter to skip):
Pressing the ENTER key for both questions will use the default version of the script which will get ALL resources.
The script will create a list of evaluated resources in a csv file (default is
A sample csv file will look like this:
Pull requests accepted!
Hillel Arnold and Amy Berish
This code is released under the MIT license. See
LICENSE for further details.