unpywall: Interfacing the Unpaywall Database with Python

Welcome to unpywall’s documentation. unpywall is a Python client that interacts with the Unpaywall database, a collection of metadata information about Open Access scholarly articles.

To get started, we recommend to read the Foreword if you want to know more about the project scope or further background information on Unpaywall. Otherwise, check out the Quickstart guide.

unpywall depends on the data analysis tool pandas and on the HTTP library requests.

Also, unpywall supports Python 3.5 and newer.

User’s Guide

• Foreword
  • What is Unpaywall?
  • Project background
• Installation
  • Python Version
  • Dependencies
  • Install unpywall
• Quickstart
  • Authentication
  • Pandas Integration
  • Query Unpaywall by DOI
• Data Format
  • Objects
  • DOI Object
  • OA Location
• Error Handling
• Cache
  • Define and Access a custom Cache
• Command-Line-Interface
  • Basic commands

API Reference

• API
  • Unpywall Object
  • Cache Object
  • Utils