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.8.tar.gz (16.2 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.8-py3-none-any.whl (19.7 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: bib_ami-0.10.8.tar.gz
  • Upload date:
  • Size: 16.2 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.8.tar.gz
Algorithm Hash digest
SHA256 a321705bddea532a31eb44d6b22cb01f120d182e0e4b4346743bac653c1b8cd8
MD5 5c0bd946d4a9e2cf324ce44c85d5b1d0
BLAKE2b-256 09895f0d976bbe4843a31911a704d2caff85e930729bbb13e1a36ed61586dd8a

See more details on using hashes here.

File details

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

File metadata

  • Download URL: bib_ami-0.10.8-py3-none-any.whl
  • Upload date:
  • Size: 19.7 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.8-py3-none-any.whl
Algorithm Hash digest
SHA256 c8b3a2f758621cfa0b33600ea1c778d15b9bad9077d28ffd46567f11a292ae91
MD5 317b50b0a525ed0d734bd3d2473d091e
BLAKE2b-256 5331214b35e946ab600576fc813f057400e67adb052a2072920ca03d999f9e13

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