bibliography-io

bibliography-io provides standalone APIs for loading and writing bibliographic records. Using the base installation does not require CoLRev or GROBID.

Installation

Install the base bibliography-io package with:

python -m pip install bibliography-io

Optional dependencies enable Markdown parsing and Excel file support:

python -m pip install "bibliography-io[markdown]"
python -m pip install "bibliography-io[excel]"
python -m pip install "bibliography-io[all]"  # both

Markdown parsing uses CoLRev and GROBID and requires a running GROBID service. Excel loading and writing require the excel extra. Markdown table writing is included in bibliography-io without an extra.

Quick example

from bibliography_io import load_raw, write

records = load_raw("references.bib")
write(records, path="references.ris")

File APIs infer formats from recognized filename suffixes. String APIs require an explicit format:

from bibliography_io import to_string
from bibliography_io import loads_raw

records = loads_raw("@article{example, title={An example}}", format="bib")
bibtex = to_string(records, format="bib")

See Usage for supported formats, API reference for the public interface, Source extensions for bibliography-io for CoLRev source hooks, and Design principles for the standalone API and compatibility contract.

Documentation

• Usage
  • File and string APIs
  • Supported formats
  • Markdown forms and optional dependencies
  • Record shape
  • DataFrame helpers
  • Format examples
  • Structured BibTeX fields
  • BibTeX field ordering
• API reference
  • Loading API
• Source extensions for bibliography-io
  • Package discovery
  • Loading hooks
  • Normalization and pipeline
• Design principles
  • Purpose and scope
  • Raw data API
  • Primary Data API
  • Exceptions
  • Compatibility policy
• Development