Python wrappers for the HathiTrust APIs
Project description
hathitrust-api
A simple interface for the HathiTrust APIs. The package contains basic classes and associated methods for querying the Bibliographic API, Data API, and the HTRC Solr Proxy.
The package is compatible with Python 2 and Python 3.
Installation
Clone and install from this repository:
git clone https://github.com/rlmv/hathitrust-api.git
cd hathitrust-api
python setup.py install
Or install directly using pip
:
pip install hathitrust-api
DataAPI
The Data API retrieves non-google public domain works from the HathiTrust.
An OAuth keyset from HathiTrust is required to use the Data API.
Example usage:
>>> from hathitrust_api import DataAPI
>>> data_api = DataAPI(your_oauth_key, your_oauth_secret)
>>> ocrtext = data_api.getpageocr('nyp.33433082228226', 120)
BibAPI
The bibliographic API delivers HathiTrust bibliographic data and MARC records in JSON format.
Example:
>>> from hathitrust_api import BibAPI
>>> bib_api = BibAPI()
>>> bib_info = bib_api.get_single_record_json('htid', 'dul1.ark:/13960/t00z82c1q')
>>> bib_info.keys()
[u'records', u'items']
>>> bib_info['records']['010944133']['publishDates']
[u'1670']
SolrAPI
The HTRC Solr Proxy is a search index over the public domain collection.
>>> from hathitrust_api import SolrAPI
>>> solr = SolrAPI()
>>> results = solr.query("new zealand", fields=['title'])
>>> results
{u'responseHeader': {u'status': 0, u'QTime': 19}, u'response': {u'start': 0, u'numFound': 366613, u'docs': [{u'title': [u'The statues of New Zealand ...']}, {u'title': [u'New Zealand.']}, {u'title': [u"Wise's New Zealand index"]}, {u'title': [u'Palaeontological bulletin.']}, {u'title': [u'New Zealand,']}, {u'title': [u'The New Zealand official year-book.']}, {u'title': [u'The New Zealand official year-book.']}, {u'title': [u'The New Zealand official year-book.']}, {u'title': [u'The New Zealand official year-book.']}, {u'title': [u'The New Zealand official year-book.']}]}}
Needed:
- Write test cases.
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
File details
Details for the file hathitrust_api-0.1.1.tar.gz
.
File metadata
- Download URL: hathitrust_api-0.1.1.tar.gz
- Upload date:
- Size: 7.1 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | ee9de3b2d77587b967355eeb1ebfafe70078607885a7af8a676644ab99b8e9d7 |
|
MD5 | edbf3d5fca6d0c2cc65e398fd5e1471d |
|
BLAKE2b-256 | 3138f8ccae2e3e63813d875ff8d7c37db0983270f120204fe2a5d466b68b105d |
File details
Details for the file hathitrust_api-0.1.1-py3-none-any.whl
.
File metadata
- Download URL: hathitrust_api-0.1.1-py3-none-any.whl
- Upload date:
- Size: 7.8 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | a1fd1d97cff4eeb27feee0747b177d9d5ecfa4bc599039762124725d3c639059 |
|
MD5 | da1babb6e24c6cd586436be34ea42b7b |
|
BLAKE2b-256 | c58efc31f51f9e24d63627d899b168aef3f653139ed3d48f3c40d1e3d834553c |