unpywall 0.1.6

Interfacing the Unpaywall Database with Python

unpywall - Interfacing the Unpaywall API with Python

Introduction

unpywall is a Python client that utilize the Unpaywall REST API for scholarly analysis with pandas.

This package is influenced by roadoi, a R client that interacts with the Unpaywall API.

Install

Install from pypi using pip:

pip install unpywall

Use

Use the get method to query the Unpaywall API. In order to interface the API, your email must be included. The method returns a pandas DataFrame.

from unpywall import Unpywall

Unpywall.get(dois=['10.1038/nature12373', '10.1093/nar/gkr1047'],
             email='[e-mail]')

By setting the parameter progress to True, you can monitore the progress of your API call.

Unpywall.get(dois=['10.1038/nature12373', '10.1093/nar/gkr1047'],
             email='[e-mail]',
             progress=True)

Keep in mind that network errors can occur. Change the errors parameter to ignore to avoid a script abort.

Unpywall.get(dois=['10.1038/nature12373', '10.1093/nar/gkr1047'],
             email='[e-mail]',
             errors='ignore')

Develop

To install unpywall, along with dev tools, run:

pip install -e .[dev]