Skip to main content

A command-line tool for improving the integrity of BibTeX bibliographies

Project description

bib-ami

CircleCI ReadTheDocs Codecov DOI

A Bibliography Integrity Manager

bib-ami is a command-line tool for improving the integrity of BibTeX bibliographies. It automates a critical data cleaning and entity resolution workflow by consolidating multiple .bib files, validating every entry against the CrossRef API to establish a canonical DOI, and then deduplicating records based on this verified identifier.

The tool intelligently categorizes entries as 'verified' or 'suspect', enabling researchers to build a clean, reliable, and auditable bibliography for their LaTeX, Zotero, or JabRef workflows.

Key Features

  • Merge & Consolidate: Combines multiple .bib files from a directory into a single source.
  • Validate & Enrich: Validates every entry against the CrossRef API to find and correct its canonical DOI.
  • Deduplicate with Confidence: Uses verified DOIs as the primary key for accurate deduplication, with a fuzzy-matching fallback for entries without a DOI.
  • Intelligent Triage: Automatically separates high-confidence, verified records from questionable ones that require manual review.
  • Audit Trail: Provides transparent reporting on the actions taken to clean the bibliography.

Getting Started

1. Installation

Ensure you have Python 3.7+ installed. You can install bib-ami using pip:

pip install bib-ami

2. Quick Start

To process a directory of .bib files, run the following command. You must provide an email address for the responsible use of the CrossRef API.

bib-ami --input-dir path/to/your/bibs --output-file cleaned.bib --suspect-file suspect.bib --email "your.email@example.com"

This will produce two files:

  • cleaned.bib: Contains the verified and accepted entries.
  • suspect.bib: Contains entries that could not be verified and require manual review.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

bib_ami-0.10.6.tar.gz (21.3 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

bib_ami-0.10.6-py3-none-any.whl (29.5 kB view details)

Uploaded Python 3

File details

Details for the file bib_ami-0.10.6.tar.gz.

File metadata

  • Download URL: bib_ami-0.10.6.tar.gz
  • Upload date:
  • Size: 21.3 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.11.13

File hashes

Hashes for bib_ami-0.10.6.tar.gz
Algorithm Hash digest
SHA256 05bebcf366b5bec4d77567faf680fb8ddd3a40ee8d9fd086289dd8188452d56a
MD5 a1dafa30efb944f9d609200463e81551
BLAKE2b-256 3351aa97b50d447c66af2b49aa7327f646988dd8a76e60efda64d159ef945c71

See more details on using hashes here.

File details

Details for the file bib_ami-0.10.6-py3-none-any.whl.

File metadata

  • Download URL: bib_ami-0.10.6-py3-none-any.whl
  • Upload date:
  • Size: 29.5 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.11.13

File hashes

Hashes for bib_ami-0.10.6-py3-none-any.whl
Algorithm Hash digest
SHA256 307ebdd2274f7b7f2eeeebabf7663b026ca792b7c4f265944a87823a80307038
MD5 bb9dc5b0bc873db24ce6bd913f693493
BLAKE2b-256 091bfb73d0784de8f7212029d9c418339cc7e2cc8603f0b9820f86ee5b14263a

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page