Skip to main content

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

Project description

richcontext.scholapi

Rich Context API integrations for federating discovery services and metadata 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 journal references
  • 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 used in the configuration file include:

parameter value
chrome_exe_path path/to/chrome.exe
core_api_key CORE API key
dimensions_password Dimensions API password
elsevier_api_key Elsvier API key
email personal email address
orcid_secret ORCID API key
repec_token RePEc API token

Download the Chrome webdriver to enable use of Selenium (SSRN only).

For a good (although slightly dated) tutorial for installing and testing Selenium on Ubuntu Linux, see: https://christopher.su/2015/selenium-chromedriver-ubuntu/

Usage

from richcontext import scholapi as rc_scholapi

# 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, timing, message = schol.openaire.title_search(title)

if message:
    # error case
    print(message)
else:
    # report results
    print(meta)
    print("\ntime: {:.3f} ms - {}".format(timing, 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

First, be sure that you're testing the source and not from an installed library.

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

python test.py

To Do

If you'd like to contribute, please see our listings of good first issues

Kudos

Contributors: @ceteri, @IanMulvany, @srand525, @lobodemonte, @ernestogimeno, plus many thanks for the inspiring 2019 Rich Context Workshop notes by @metasj, and guidance from @claytonrsh, @Juliaingridlane.

Project details


Download files

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

Source Distribution

richcontext-scholapi-1.1.0.tar.gz (14.1 kB view details)

Uploaded Source

Built Distribution

richcontext_scholapi-1.1.0-py3-none-any.whl (10.8 kB view details)

Uploaded Python 3

File details

Details for the file richcontext-scholapi-1.1.0.tar.gz.

File metadata

  • Download URL: richcontext-scholapi-1.1.0.tar.gz
  • Upload date:
  • Size: 14.1 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.1.1 pkginfo/1.5.0.1 requests/2.22.0 setuptools/45.1.0 requests-toolbelt/0.9.1 tqdm/4.41.0 CPython/3.7.4

File hashes

Hashes for richcontext-scholapi-1.1.0.tar.gz
Algorithm Hash digest
SHA256 e31ccae2b9d22541862f80c86d7b91a3e40da875e6d61f0b134b26cc2eabaf9b
MD5 de135b69a9c066b8be755475528a7447
BLAKE2b-256 6e761d60cbcca44206a2c8e8d696ee067c2ae81a995895e6bd87db373b646e39

See more details on using hashes here.

File details

Details for the file richcontext_scholapi-1.1.0-py3-none-any.whl.

File metadata

  • Download URL: richcontext_scholapi-1.1.0-py3-none-any.whl
  • Upload date:
  • Size: 10.8 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.1.1 pkginfo/1.5.0.1 requests/2.22.0 setuptools/45.1.0 requests-toolbelt/0.9.1 tqdm/4.41.0 CPython/3.7.4

File hashes

Hashes for richcontext_scholapi-1.1.0-py3-none-any.whl
Algorithm Hash digest
SHA256 4014874395964ee30b43e46ac6da87c104d476491cbba2904e3038c483fb5cb1
MD5 78431a587bfbe7785a82a7c83290703c
BLAKE2b-256 c00f15b84c71b61c9b3ae6cd58af0a09fabc815691e306176c551abfbddc1a39

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page