pyzotero
Scannednpx machina-cli add skill K-Dense-AI/claude-scientific-skills/pyzotero --openclawPyzotero
Pyzotero is a Python wrapper for the Zotero API v3. Use it to programmatically manage Zotero libraries: read items and collections, create and update references, upload attachments, manage tags, and export citations.
Authentication Setup
Required credentials — get from https://www.zotero.org/settings/keys:
- User ID: shown as "Your userID for use in API calls"
- API Key: create at https://www.zotero.org/settings/keys/new
- Library ID: for group libraries, the integer after
/groups/in the group URL
Store credentials in environment variables or a .env file:
ZOTERO_LIBRARY_ID=your_user_id
ZOTERO_API_KEY=your_api_key
ZOTERO_LIBRARY_TYPE=user # or "group"
See references/authentication.md for full setup details.
Installation
uv add pyzotero
# or with CLI support:
uv add "pyzotero[cli]"
Quick Start
from pyzotero import Zotero
zot = Zotero(library_id='123456', library_type='user', api_key='ABC1234XYZ')
# Retrieve top-level items (returns 100 by default)
items = zot.top(limit=10)
for item in items:
print(item['data']['title'], item['data']['itemType'])
# Search by keyword
results = zot.items(q='machine learning', limit=20)
# Retrieve all items (use everything() for complete results)
all_items = zot.everything(zot.items())
Core Concepts
- A
Zoteroinstance is bound to a single library (user or group). All methods operate on that library. - Item data lives in
item['data']. Access fields likeitem['data']['title'],item['data']['creators']. - Pyzotero returns 100 items by default (API default is 25). Use
zot.everything(zot.items())to get all items. - Write methods return
Trueon success or raise aZoteroError.
Reference Files
| File | Contents |
|---|---|
| references/authentication.md | Credentials, library types, local mode |
| references/read-api.md | Retrieving items, collections, tags, groups |
| references/search-params.md | Filtering, sorting, search parameters |
| references/write-api.md | Creating, updating, deleting items |
| references/collections.md | Collection CRUD operations |
| references/tags.md | Tag retrieval and management |
| references/files-attachments.md | File retrieval and attachment uploads |
| references/exports.md | BibTeX, CSL-JSON, bibliography export |
| references/pagination.md | follow(), everything(), generators |
| references/full-text.md | Full-text content indexing and retrieval |
| references/saved-searches.md | Saved search management |
| references/cli.md | Command-line interface usage |
| references/error-handling.md | Errors and exception handling |
Common Patterns
Fetch and modify an item
item = zot.item('ITEMKEY')
item['data']['title'] = 'New Title'
zot.update_item(item)
Create an item from a template
template = zot.item_template('journalArticle')
template['title'] = 'My Paper'
template['creators'][0] = {'creatorType': 'author', 'firstName': 'Jane', 'lastName': 'Doe'}
zot.create_items([template])
Export as BibTeX
zot.add_parameters(format='bibtex')
bibtex = zot.top(limit=50)
# bibtex is a bibtexparser BibDatabase object
print(bibtex.entries)
Local mode (read-only, no API key needed)
zot = Zotero(library_id='123456', library_type='user', local=True)
items = zot.items()
Source
git clone https://github.com/K-Dense-AI/claude-scientific-skills/blob/main/scientific-skills/pyzotero/SKILL.mdView on GitHub Overview
Pyzotero is a Python wrapper for the Zotero API v3. It lets you programmatically manage Zotero libraries: read items and collections, create and update references, upload attachments, manage tags, and export citations. This enables building automation workflows and integrations that streamline bibliographic management.
How This Skill Works
Pyzotero provides a Zotero client bound to a single library (user or group) and exposes high‑level methods such as top, items, item, update_item, and everything. You authenticate with User ID, API Key, and Library ID (via environment variables or a .env file) and then perform actions against the Zotero Web API v3. Results are Python dictionaries representing items, collections, and attachments, with item data accessible at item['data'].
When to Use It
- Programmatically read, create, update, or delete items and collections in a Zotero library
- Automate bibliographic workflows and research pipelines that integrate with Zotero
- Upload PDF attachments and manage files linked to Zotero items
- Export citations in BibTeX, CSL-JSON, or other supported formats
- Search, filter, and paginate library contents across items, collections, tags, and attachments
Quick Start
- Step 1: Install Pyzotero (uv add pyzotero or uv add "pyzotero[cli]")
- Step 2: Configure credentials in environment variables: ZOTERO_LIBRARY_ID, ZOTERO_API_KEY, ZOTERO_LIBRARY_TYPE
- Step 3: Initialize the Zotero client in Python and run a simple query like zot.top(limit=10) or zot.items(q='topic')
Best Practices
- Store credentials securely (use environment variables or a .env file) and avoid hard-coding keys
- Use item templates (e.g., journalArticle) when creating new references to ensure required fields
- Validate item data (title, creators) before updates and handle ZoteroError exceptions
- Leverage everything() or follow() to paginate large libraries and retrieve complete results
- Prefer scoped operations and test with a small subset before modifying production libraries
Example Use Cases
- Retrieve the top 10 items from a user library and print titles
- Search the library by keyword (e.g., 'machine learning') and iterate results
- Export a library portion to BibTeX or CSL-JSON for use in manuscripts
- Upload a PDF as an attachment to an existing item
- Create a new reference from a template and update its fields programmatically
