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.11.1.tar.gz (18.0 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.11.1-py3-none-any.whl (21.6 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: bib_ami-0.11.1.tar.gz
  • Upload date:
  • Size: 18.0 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.11.1.tar.gz
Algorithm Hash digest
SHA256 6f15385c05f894e2674331e15eb314063f2cb3b2cef2719cb6f65a3ecbed0ea4
MD5 5ffe545af7946ea0029c35ea59da317c
BLAKE2b-256 f78f9aa329e340eb8703f5b65cf1bacf988f58199aeffe0e58e6dbe1b1b7021f

See more details on using hashes here.

File details

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

File metadata

  • Download URL: bib_ami-0.11.1-py3-none-any.whl
  • Upload date:
  • Size: 21.6 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.11.1-py3-none-any.whl
Algorithm Hash digest
SHA256 9fd3e756bfa119056b4b324c6def5a04ead1c0a3b6e6402dc2b824c43bc0bb13
MD5 12374970b2dead3ec6175246a1c2b81e
BLAKE2b-256 6ec564ab8b5a13a3e3e5417d6285ddfc0f7c326625ef335a22471d27411106b5

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