dartboard

generalized Internet Archive upload target

dartboard is available on PyPi as dartboard-ia!

Configuration

There are two ways you can provide dartboard with Internet Archive credentials to be able to upload:

• If you use the IA CLI (and you've run ia configure) dartboard will automatically use those credentials
• Otherwise, you can create a config json file (see below) and pass the location of it with --config-path (default: ./config.json)

{
  "s3_key": "abcdefg",
  "s3_secret": "abcdefg"
}

Usage instructions

You can upload a directory with

dartboard path/to/directory

dartboard will try to upload to the item with the same identifier as the name of the directory. If the item does not already exist on IA, you must specify the metadata by placing an __ia_meta.json file in the directory:

{
  "collection": "opensource",
  "mediatype": "data",
  "title": "My title",
  "description": "My description",
  "foo": "bar"
}

You are required to specify, at minimum, a collection and mediatype to create a new item.

If the item already exists, dartboard will try to upload the files to it even if __ia_meta.json isn't present. If it is present, dartboard WILL attempt to diff the metadata and make the necessary changes once it has finished uploading the new files.

You can also specify dartboard settings for that item with an __uploader_meta.json file:

{
  "setUploadState": false, // if enabled, dartboard will set an upload-state:uploading key on the item, and change it to upload-state:uploaded when done
  "setScanner": true, // if disabled, dartboard will not add "dartboard (vX.Y.Z)" to the scanner field
  "sendSizeHint": false, // if enabled, dartboard will send IA a size hint for the item, based on the size of files in the directory. Only enable this for new items, and only if you know that every file you want to upload to this item is already in the directory
  "derive": true // if disabled, dartboard will not queue a derive task once it has finished uploading
}

(Values shown above are the defaults. The comments in JSON are only to make reading easier - don't include them when running the actual command)