Pyzotero: An API Client for the Zotero API

Quickstart

pip install pyzotero or conda config --add channels conda-forge && conda install pyzotero
You'll need the ID of the personal or group library you want to access:
- Your personal library ID is available here, in the section Your userID for use in API calls
- For group libraries, the ID can be found by opening the group's page: https://www.zotero.org/groups/groupname, and hovering over the group settings link. The ID is the integer after /groups/
You'll also need^† to get an API key here
Are you accessing your own Zotero library? library_type is 'user'
Are you accessing a shared group library? library_type is 'group'.

Then:

from pyzotero import zotero
zot = zotero.Zotero(library_id, library_type, api_key)
items = zot.top(limit=5)
# we've retrieved the latest five top-level items in our library
# we can print each item's item type and ID
for item in items:
    print('Item: %s | Key: %s' % (item['data']['itemType'], item['data']['key']))

Documentation

Full documentation of available Pyzotero methods, code examples, and sample output is available on Read The Docs.

Installation

Using pip: pip install pyzotero (it's available as a wheel, and is tested on Python 3.7 and up)
Using Anaconda:conda config --add channels conda-forge && conda install pyzotero
From a local clone, if you wish to install Pyzotero from a specific branch:

Example:

git clone git://github.com/urschrei/pyzotero.git
cd pyzotero
git checkout dev
pip install .

Testing

Run pytest . from the top-level directory.

Issues

The latest commits can be found on the dev branch, although new features are currently rare. If you encounter an error, please open an issue.

Pull Requests

Pull requests are welcomed. Please read the contribution guidelines. In particular, please base your PR on the dev branch.

Versioning

As of v1.0.0, Pyzotero is versioned according to Semver; version increments are performed as follows:

MAJOR version will increment with incompatible API changes,
MINOR version will increment when functionality is added in a backwards-compatible manner, and
PATCH version will increment with backwards-compatible bug fixes.

Citation

Pyzotero has a DOI:

You may also cite Pyzotero using CITATION.cff.
A sample citation (APA 6th edition) might look like:

Stephan Hügel, The Pyzotero Authors (2019, May 18). urschrei/pyzotero: Version v1.3.15. http://doi.org/10.5281/zenodo.2917290

License

Pyzotero is licensed under the Blue Oak Model Licence 1.0.0. See LICENCE.md for details.

† This isn't strictly true: you only need an API key for personal libraries and non-public group libraries.

urschrei / pyzotero

readme