Skip to main content

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

Project description

bib-ami

CircleCI ReadTheDocs Codecov DOI

bib-ami: The 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.9.4.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.9.4-py3-none-any.whl (22.6 kB view details)

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for bib_ami-0.9.4.tar.gz
Algorithm Hash digest
SHA256 924c3f96c194ba05ba40215bed8587ee970a968cd1706e9a5fb77d5fc40b1cb8
MD5 4a7378816d61da3906f7e9ca7ad66237
BLAKE2b-256 0c8eb477fb2b9307db04bb1b1108523ce870c2669c135ea34df3bf4cf079370e

See more details on using hashes here.

File details

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

File metadata

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

File hashes

Hashes for bib_ami-0.9.4-py3-none-any.whl
Algorithm Hash digest
SHA256 117edf023732515ec7df3a01b8828d4e67c4222791ec9f8c79e99c8ef997e566
MD5 257ac996cb0725e31e5e502c73c8ddee
BLAKE2b-256 1e79dcc5a0471dddc7eab9e5180af4d063e287c4aac4cdebc8511e2124ea096d

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