Skip to main content

A python client for Open Library

Project description

openlibrary-client
==================

![Travis CI build status](https://travis-ci.org/internetarchive/openlibrary-client.svg?branch=master)

A reference client library for the Open Library API. Tested with Python 2.7, 3.5, 3.6.

- [Installation](#installation)
- [Configuration](#configuration)
- [Usage](#usage)
- [Testing](#testing)
- [Other Client Libraries](#other-client-libraries)

## Installation

As a prerequisite, openlibrary-client requires libssl-dev for the cryptography used in openssl. for Ubuntu kindly use the following command:

```
$ sudo apt install libssl-dev
```

For Fedora/RHEL, use the following command to install libssl-dev for crypptography used in openssl.
```
$ sudo dnf install openssl-dev
```

If you plan on doing MARC parsing, you'll need `yaz` (see: https://github.com/indexdata/yaz). Assuming Ubuntu/debian, you can install `yaz` via apt:

```
$ sudo apt install yaz
```

For Fedora/RHEL, use the following command to install `yaz`
```
$ sudo dnf install yaz
```

You'll also need python dev tools:

```
$ sudo apt install python-dev # for python 2
$ sudo apt install python3-dev # for python 3
```

For Fedora/RHEL, use:
```
$ sudo dnf install python2-devel # for python2.x installs
$ sudo dnf install python3-devel # for python3.x installs
```


To install the openlibrary-client package:
```
$ git clone https://github.com/internetarchive/openlibrary-client.git
$ cd openlibrary-client
$ pip install .
```

## Configuration

Many Open Library actions (like creating Works and Editions) require authentication, i.e. certain requests must be provided a valid cookie of a user which has been logged in with their openlibrary account credentials. The openlibrary-client can be configured to "remember you" so you don't have to provide credentials with each request.

First time users may run the following command to enable the "remember me" feature. This process will ask for an **Archive.org email and password**, will authenticate the credentials, and then store the account's corresponding s3 keys in `~/.config/ol.ini` (or whichever config location the user has specified):

```
$ ol --configure --email mek@archive.org
password: ***********
Successfully configured
```

## Usage

### Python Library

For more examples, you can take a look at our [examples directory](examples/scripts) on Python Scripts for specific use cases that are needed.

#### Adding a new Book

Fun things you can do to add a new book to Open Library
```python
>>> from olclient.openlibrary import OpenLibrary
>>> import olclient.common as common
>>> ol = OpenLibrary()
>>> book = common.Book(title=u"Warlight: A novel", authors=[common.Author(name=u"Michael Ondaatje")], publisher=u"Deckle Edge", publish_date=u"2018")
>>> book.add_id(u'isbn_10', u'0525521194')
>>> book.add_id(u'isbn_13', u'978-0525521198')
>>> new_book = ol.create_book(book)
>>> new_book.add_bookcover('https://images-na.ssl-images-amazon.com/images/I/51kmM%2BvVRJL._SX337_BO1,204,203,200_.jpg')
```

#### Works

Fun things you can do with an Work:

```python
>>> from olclient.openlibrary import OpenLibrary
>>> ol = OpenLibrary()
>>> work = ol.Work.get(u'OL12938932W')
>>> editions = work.editions
```
One thing to consider in the snippet above is that work.editions is a @property which makes several http requests to OpenLibrary in order to populate results. Once a call has been made to work.editions, its editions are saved/cached as work._editions.

#### Editions

Fun things you can do with an Edition:
```
>>> from olclient.openlibrary import OpenLibrary
>>> ol = OpenLibrary()
>>> edition = ol.Edition.get(u'OL25952968M')
>>> authors = edition.authors
>>> work = edition.work
>>> work.add_bookcover(u'https://covers.openlibrary.org/b/id/7451891-L.jpg')
>>> edition.add_bookcover(u'https://covers.openlibrary.org/b/id/7451891-L.jpg')
```

### Command Line Tool

Installing the openlibrary-client library will also install the `ol` command line utility. Right now it does exactly nothing.

```
$ ol

usage: ol [-h] [-v] [--configure] [--get-work] [--get-book] [--get-olid]
[--olid OLID] [--isbn ISBN] [--create CREATE] [--title TITLE]
[--baseurl BASEURL] [--email EMAIL]

olclient

optional arguments:
-h, --help show this help message and exit
-v Displays the currently installed version of ol
--configure Configure ol client with credentials
--get-work Get a work by --title, --olid
--get-book Get a book by --isbn, --olid
--get-olid Get an olid by --title or --isbn
--olid OLID Specify an olid as an argument
--isbn ISBN Specify an isbn as an argument
--create CREATE Create a new work from json
--title TITLE Specify a title as an argument
--baseurl BASEURL Which OL backend to use
--email EMAIL An IA email for requests which require authentication.
You will be prompted discretely for a password
```

You can create a new work from the command line using the following syntax. It's almost identical to the olclient.common.Book object construction, except instead of providing an Author object, you instead pass a key for "author" and a corresponding value:

```
> ol --create '{"title": "The Cartoon Guide to Calculus", "publisher": "Teach Yourself", "publish_date": "2013", "identifiers": {"isbn_10": ["144419111X"]}, "cover": "https://images-na.ssl-images-amazon.com/images/I/51aJdEGttLL._SX328_BO1,204,203,200_.jpg", "author": "Hugh Neill"}'
OL26194598M
```

Successful creation of a new Work results in the return of its Open Library edition ID.

## Testing

To run test cases (from the openlibrary-client directory):

```
$ py.test tests/
```

## Other Client Libraries

Other Open Library client libraries include:
- Ruby: https://github.com/jayfajardo/openlibrary
- Javascript: https://github.com/onaclovtech/openlibrary
- Python: https://github.com/felipeborges/python-openlibrary and https://github.com/the-metalgamer/python-openlibrary-client
- PHP: https://github.com/beezus/openlibrary-php


Project details


Download files

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

Filename, size & hash SHA256 hash help File type Python version Upload date
openlibrary_client-0.0.18-py2.py3-none-any.whl (26.0 kB) Copy SHA256 hash SHA256 Wheel py2.py3 Jul 8, 2018
openlibrary-client-0.0.18.tar.gz (22.2 kB) Copy SHA256 hash SHA256 Source None Jul 8, 2018

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 DigiCert DigiCert EV certificate StatusPage StatusPage Status page