Skip to content

Commit

Permalink
Docs
Browse files Browse the repository at this point in the history
  • Loading branch information
tmorrell committed Feb 5, 2018
1 parent 6ad32ac commit f2dc2e1
Showing 1 changed file with 8 additions and 8 deletions.
16 changes: 8 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,24 +25,24 @@ CaltechDATA integration requires [caltechdata_api](https://github.com/caltechlib
## CodeMeta Updating

#### Setup
You need to set environmental variables with your token to access
CaltechDATA (TINDTOK)
You need to set an environmental variable with your token to access
CaltechDATA `export TINDTOK=`

#### Usage
Type `python run_codemeta.py`. This will harvest all the repos present in
Type `python run_codemeta.py`. This will harvest all the repos present in
CaltechDATA, search them for codemeta.json files, and update the metadata
in CaltechDATA. There are more fields that could be mapped in the future.
in CaltechDATA. There are more fields that could be mapped in the future.

## CaltechDATA Citation Alerts

#### Setup
You need to set environmental variables with your token to access
CaltechDATA (TINDTOK) and Mailgun (MAILTOK). Access to data on S3 is currently
CaltechDATA `export TINDTOK=` and Mailgun `export MAILTOK=`. Access to data on S3 is currently
restricted to Caltech Library staff and your S3 configuration needs to be set up
following the instructions in dataset.
following the instructions in Dataset.

#### Usage
You will automatically generate citation alerts for all DOIs in the CaltechDATA repository.
Type `python run_event_data.py`. You will automatically generate citation alerts for all DOIs in the CaltechDATA repository.
This script collects citation data from the Crossref Event Data API, matches DOIs with those
in CaltechDATA, updates the metadata in CaltechDATA, and sends an email alert to the contact
person for the data record. To run this process type 'python run_event_data.py'. You'll be prompted if any citations are found.
person for the data record. You'll be prompted if any citations are found.

0 comments on commit f2dc2e1

Please sign in to comment.