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.14.0.tar.gz (18.4 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.14.0-py3-none-any.whl (22.0 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: bib_ami-0.14.0.tar.gz
  • Upload date:
  • Size: 18.4 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.14.0.tar.gz
Algorithm Hash digest
SHA256 1089ef23bae51b260d2d6571f5c885ea829818bd0520e7adff9b3a74ba27cf15
MD5 c3ddee13fa4690db331269fd2a3272c6
BLAKE2b-256 d740ba78644c788e372e7f7ea714f4cd470d45476c1deaa0f2f9a5cdcb40bb94

See more details on using hashes here.

File details

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

File metadata

  • Download URL: bib_ami-0.14.0-py3-none-any.whl
  • Upload date:
  • Size: 22.0 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.14.0-py3-none-any.whl
Algorithm Hash digest
SHA256 d7d1b56f89c4700ecb0e9267deee803dec857d25632bc8ab5e3aa22b02f54b58
MD5 5225ec49fb3b984736fb07315c0f0959
BLAKE2b-256 fbceadc240c026f669cf085d58480a4013ac380c76ef0b8c2bd7f1868ab1d3a3

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