Skip to main content

Rich Context API integrations for federating metadata discovery and exchange across multiple scholarly infrastructure providers

Project description

richcontext.scholapi

Rich Context API integrations for federating metadata discovery and exchange across multiple scholarly infrastructure providers.

Development of the Rich Context knowledge graph uses this library to:

  • identify dataset links to research publications
  • locate open access publications
  • reconcile author profiles
  • reconcile keyword mesh

This library has been guided by collaborative work on community building and metadata exchange to improve Scholarly Infrastructure, held at the 2019 Rich Context Workshop.

Installation

Prerequisites:

To install from PyPi:

pip install richcontext.scholapi

If you install directly from this Git repo, be sure to install the dependencies as well:

pip install -r requirements.txt

Then copy the configuration file template rc_template.cfg to rc.cfg and populate it with your credentials.

NB: be careful not to commit the rc.cfg file in Git since it contains sensitive data such as passwords.

Parameters needed in the configuration file include:

parameter value
chrome_exe_path path/to/chrome.exe
dimensions_password Dimensions API password
email personal email address
repec_token RePEc API token

Download the Chrome webdriver to enable use of Selenium.

Usage

from richcontext import scholapi as rc_scholapi
import pprint

# initialize the federated API access
schol = rc_scholapi.ScholInfraAPI(config_file="rc.cfg", logger=None)

# search parameters for example publications
title = "Deal or no deal? The prevalence and nutritional quality of price promotions among U.S. food and beverage purchases."

# run it...
meta = schol.openaire.title_search(title)

# report results
pprint.pprint(meta)
print("\ntime: {:.3f} ms - {}".format(schol.openaire.elapsed_time, schol.openaire.name))

API Integrations

APIs used to retrieve metadata:

See docs/enrich_pubs.ipynb for example API usage to pull the federated metadata for a publication.

For more background about open access publications see:

Piwowar H, Priem J, Larivière V, Alperin JP, Matthias L, Norlander B, Farley A, West J, Haustein S. 2017.
The State of OA: A large-scale analysis of the prevalence and impact of Open Access articles
PeerJ Preprints 5:e3119v1
https://doi.org/10.7287/peerj.preprints.3119v1

Testing

To run unit tests for the APIs which do not require credentials:

python test/test.py

To run unit tests for all of the APIs:

python test/full_test.py

To Do

Kudos

Contributors: @ceteri, @srand525, plus many thanks for the inspiring 2019 Rich Context Workshop notes by @metasj.

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 richcontext-scholapi, version 1.0.0
Filename, size File type Python version Upload date Hashes
Filename, size richcontext_scholapi-1.0.0-py3-none-any.whl (7.2 kB) File type Wheel Python version py3 Upload date Hashes View
Filename, size richcontext-scholapi-1.0.0.tar.gz (7.9 kB) File type Source Python version None Upload date Hashes View

Supported by

AWS AWS Cloud computing Datadog Datadog Monitoring DigiCert DigiCert EV certificate Facebook / Instagram Facebook / Instagram PSF Sponsor Fastly Fastly CDN Google Google Object Storage and Download Analytics Pingdom Pingdom Monitoring Salesforce Salesforce PSF Sponsor Sentry Sentry Error logging StatusPage StatusPage Status page