/pyzotero

A Python wrapper for the Zotero API

Primary LanguagePythonGNU General Public License v3.0GPL-3.0

Build Status Wheel Status Supported Python versions

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'])

Description

Pyzotero is a Python wrapper for the Zotero read and write APIs (currently API v3). You'll require a library ID and access key, which can be set up here.

See Read The Docs for full documentation of available Pyzotero methods, code examples, and sample output.

Installation

  • Using pip: pip install pyzotero
  • From a wheel: pip install --use-wheel 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 .

Installation using easy_install may be successful, but is neither tested nor officially supported – pip is the preferred method.

Testing

Run test_zotero.py in the pyzotero/test directory, or, using Nose, nosetests from the top-level directory.

Issues

Pyzotero remains in development as of October 2014. The latest commits can be found on the dev branch. If you encounter an error, please open an issue.

Pull Requests

Pull requests are welcomed. Please read the contribution guidelines.

Versioning

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

  1. MAJOR version when you make incompatible API changes,
  2. MINOR version when you add functionality in a backwards-compatible manner, and
  3. PATCH version when you make backwards-compatible bug fixes.

License

Pyzotero is licensed under version 3 of the GNU General Public License. See license.txt for details.