Repository files navigation

Thecaltechdata_api Python library provides a convenient interface for interacting with the CaltechDATA API. It allows users to write files, create DataCite 4 standard JSON records, edit existing records, and retrieve metadata from the CaltechDATA repository.

• caltechdata_write: Writes files and a DataCite 4 standard JSON record to the CaltechDATA repository.
• caltechdata_edit: Edits existing records in CaltechDATA.

• get_metadata: Retrieves metadata from CaltechDATA records.

• Python 3.6+

Install the library via pip:

pip install caltechdata_api

There are some example python scripts in the GitHub repository.

python write.py example.json -fnames logo.gif# Output: pbkn6-m9y63 (unique identifier)

The response will be the unique identifier for the record. You can put this atthe end of a url to visit the record (e.g.https://data.caltechlibrary.dev/records/pbkn6-m9y63)

Make changes to the example.json file to see a change)

python edit.py example.json -id pbkn6-m9y6310.33569/pbkn6-m9y63

The response is the DOI for the record, which includes the unique identifierfor the record in the default configuration.

Some groups have worked with the library to create custom DOIs. These can bepassed in the metadata like:

python write.py example_custom.json -fnames logo.gifm6zxz-p4j22

And then you can edit with

python edit.py example_custom.json -id m6zxz-p4j2210.5281/inveniordm.1234

This returns the custom DOI of the record if it is successful.

1. Acquire a personal access token from your CaltechDATA account (found under "Applications" at the top right of your screen).
2. Copy the token to a file named token.bash.
3. Load the token in the command line using source token.bash.

Only test your application on the test repository (data.caltechlibrary.dev). Testing the API on the publicrepository will generate junk records that are annoying to delete.

If you would like to interact with the CaltechDATA API using the Command line Interface (CLI), pleasesee the detailed documentation.