Skip to main content
Join the official 2019 Python Developers SurveyStart the survey!

Python wrapper for CaltechDATA API.

Project description

caltechdata_api

DOI

Python library for using the CaltechDATA API

  • caltechdata_write write files and a DataCite 4 standard json record to CaltechDATA repository
  • caltechdata_edit edits records in CaltechDATA
  • get_metadata gets metadata from CaltechDATA records

Requires Python 3 (Recommended via Anaconda https://www.anaconda.com/download) with reqests library.

Examples

There are some example python scripts in the GitHub repository.

Create a record:

python example.py example.json -fnames logo.gif
Successfully created record https://cd-sandbox.tind.io/records/352.  

Edit a record (make changes to the example.json file to see a change)

python edit.py example.json -ids 352 -fnames logo.gif
Successfully modified record https://cd-sandbox.tind.io/records/352

Get geographic metadata from CaltechDATA with WKT representations in a csv file. You can import this to a GIS program like QGIS using a delimited text import and projection epsg:4326. You'll have to do one import for Geometry type Point and another for Geometry type Polygon.

python get_geo.py caltechdata_geo.csv

You can filter by keyword

python get_geo.py caltechdata_geo.csv -keywords TCCON

Setup

Install by typing 'pip install caltechdata_api'

Usage

Write API access is controlled by repository staff. Email us at data@caltech.edu with your request if you want to use the write API.

You need to acquire a personal access token from your CaltechDATA account (find it at the top right of your screen under "Applications"). Make sure you include the "deposit_api:write" and "file_manager:upload" scopes. Then copy the token to token.bash. Type source token.bash in the command line to load the token.

Only test your application on the test repository. Testing the API on the public repository will generate junk records that are annoying to delete.

TODO

Handle incorrect token on file upload

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Files for caltechdata-api, version 0.1.5
Filename, size File type Python version Upload date Hashes
Filename, size caltechdata_api-0.1.5-py3-none-any.whl (13.1 kB) File type Wheel Python version py3 Upload date Hashes View hashes
Filename, size caltechdata_api-0.1.5.tar.gz (13.8 kB) File type Source Python version None Upload date Hashes View hashes

Supported by

Elastic Elastic Search Pingdom Pingdom Monitoring Google Google BigQuery Sentry Sentry Error logging AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN SignalFx SignalFx Supporter DigiCert DigiCert EV certificate StatusPage StatusPage Status page