Skip to content

Repository files navigation

habanero

pypi Docs ghactions coverage Ruff uv

This is a low level client for working with Crossref's search API. It's been named to be more generic, as other organizations are/will adopt Crossref's search API, making it possible to interact with all from one client.

Crossref API docs

habanero docs

Other Crossref API clients:

Crossref's API issue tracker: https://crossref.atlassian.net/jira/software/c/projects/CR/issues/

Note about searching:

You are using the Crossref search API described at https://api.crossref.org/swagger-ui/index.html. When you search with query terms, on Crossref servers they are not searching full text, or even abstracts of articles, but only what is available in the data that is returned to you. That is, they search article titles, authors, etc. For some discussion on this, see https://gitlab.com/crossref/issues/-/issues/101

Rate limits

See the headers X-Rate-Limit-Limit and X-Rate-Limit-Interval for current rate limits.

The Polite Pool

To get in the polite pool it's a good idea now to include a mailto email address. See docs for more information.

Installation

Stable version

# pip
pip install habanero

# uv w/ legacy project setup
uv pip install habanero
# uv w/ pyproject.toml
uv add habanero

If you would like to fix bibtex format citations using content negotiation you'll have to install the optional dependency bibtexparser >= 2.0.0b7 (done for you with optional [bibtex])

pip install habanero[bibtex]

Dev version

pip install git+https://github.com/sckott/habanero.git#egg=habanero

Or build it yourself locally

git clone https://github.com/sckott/habanero.git
cd habanero
make install

Meta

About

Python client for Crossref search API

Topics

Resources

Code of conduct

Contributing

Stars

Watchers

Forks

Releases

Used by

Contributors

Languages