bibliography-io provides standalone loading and writing of bibliographic records. Its core API does not require CoLRev or GROBID.

Installation

Install the base package with:

pip install bibliography-io

The optional colrev extra is for legacy compatibility modules. It is not needed by the core file and string APIs. Markdown reference-list parsing has no released optional backend yet.

Usage

from bibliography_io import load_records, write_records

records = load_records("references.bib")
write_records(records, "references.ris")

File APIs infer the format from recognized suffixes; an explicit format can override inference. String APIs always require format:

from bibliography_io import dumps, loads

records = loads("@article{example, title={An example}}", format="bib")
text = dumps(records, format="bib")

Format support

Markdown table serialization is built into the core. Markdown reference-list parsing is a separate optional feature; its backend and installation extra are not finalized. Requesting Markdown input without a registered backend raises OptionalBackendUnavailableError.

Historical root aliases (load, write, write_file, to_string, load_df, and get_nr_records) are deprecated immediately and will be removed in a future release.

See the documentation for installation details, usage examples, and the generated API reference.

Development

Install the package's test extra and run the standalone test suite. The tests use the package API and do not require CoLRev:

pip install -e ".[test]"
pip install build pre-commit
pre-commit install
pre-commit run --all-files
pytest

Build the documentation locally with:

pip install -e ".[docs]"
python -m sphinx -W --keep-going -b html docs docs/_build/html

See RELEASING.md for the package build and publication process.

License

This project is distributed under the MIT License.