Skip to main content

Boost your bibliography by updating BibTeX entries with published conference versions

Project description

BibBoost

A CLI tool to update BibTeX files with conference versions of papers using the Semantic Scholar API.

Features

  • Interactive paper selection - Choose from multiple versions with detailed information
  • Complete metadata replacement - Uses Semantic Scholar's complete BibTeX entries
  • Smart preprint detection - Only processes arXiv/preprint entries
  • Backup protection - Creates backups before modifying files
  • Dry-run mode - Preview changes without writing files

Installation

uv add click bibtexparser requests python-dotenv questionary tenacity

Usage

Basic Usage

# Interactive update with complete metadata
uv run python main.py update-bib papers.bib

# Preview changes without modifying the file
uv run python main.py update-bib papers.bib --dry-run --verbose

# Save to a different output file
uv run python main.py update-bib papers.bib --output updated_papers.bib

With API Key (Recommended)

Get a free API key from Semantic Scholar for better rate limits:

  1. Set environment variable:
export SEMANTIC_SCHOLAR_API_KEY="your-api-key"
uv run python main.py update-bib papers.bib
  1. Or pass it directly:
uv run python main.py update-bib papers.bib --api-key "your-api-key"

Options

  • --output/-o: Specify output file (default: updates input file)
  • --api-key: Semantic Scholar API key
  • --dry-run: Preview changes without writing files
  • --verbose/-v: Show detailed progress
  • --backup/--no-backup: Create backup file (default: True)

How It Works

  1. Parse BibTeX file - Identifies preprint/arXiv entries (skips published papers)
  2. Search Semantic Scholar - Finds all available versions of each paper
  3. Interactive selection - Shows detailed paper information for user choice:
    • Original BibTeX entry details
    • All found versions with authors, venues, and years
    • Visual separators for easy scanning
  4. Complete replacement - Uses Semantic Scholar's complete BibTeX citation
  5. Preserve citation keys - Keeps your original IDs for existing citations

Interactive Selection

When multiple versions are found, you'll see:

๐Ÿ“„ Found multiple versions for: Attention Is All You Need

๐Ÿ“š Original BibTeX entry:
   ID: attention2017
   Title: Attention Is All You Need
   Authors: Ashish Vaswani and others
   Journal: arXiv preprint arXiv:1706.03762
   Year: 2017
   arXiv: 1706.03762

โ•โ•โ•โ•โ•โ•โ•โ•โ•โ•โ•โ•โ•โ•โ•โ•โ•โ•โ•โ•โ•โ•โ•โ•โ•โ•โ•โ•โ•โ•โ•โ•โ•โ•โ•โ•โ•โ•โ•โ•โ•โ•โ•โ•โ•โ•โ•โ•โ•โ•โ•โ•โ•โ•โ•โ•โ•โ•โ•โ•โ•โ•โ•โ•โ•โ•โ•โ•โ•โ•

? Choose the version to use:
 โ†’ Attention is All you Need
    Authors: Ashish Vaswani, Noam M. Shazeer, Niki Parmar, et al.
    Venue: Neural Information Processing Systems (2017) - Conference
    โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€

   Skip (keep original version)

Complete Metadata Replacement

The tool uses Semantic Scholar's citationStyles.bibtex field to get complete, properly formatted entries:

Before (arXiv preprint):

@article{attention2017,
  title={Attention Is All You Need},
  author={Ashish Vaswani and others},
  journal={arXiv preprint arXiv:1706.03762},
  year={2017}
}

After (complete conference version):

@article{attention2017,
  author = {Ashish Vaswani and Noam M. Shazeer and Niki Parmar and Jakob Uszkoreit and Llion Jones and Aidan N. Gomez and Lukasz Kaiser and I. Polosukhin},
  booktitle = {Neural Information Processing Systems},
  pages = {5998-6008},
  title = {Attention is All you Need},
  year = {2017}
}

Benefits:

  • โœ… Complete author lists (not truncated)
  • โœ… Exact venue names and formatting
  • โœ… Page numbers, volumes, and other metadata
  • โœ… Proper BibTeX formatting from authoritative source
  • โœ… No manual field mapping required

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

bibboost-0.1.0.tar.gz (8.8 kB view details)

Uploaded Source

Built Distribution

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

bibboost-0.1.0-py3-none-any.whl (9.9 kB view details)

Uploaded Python 3

File details

Details for the file bibboost-0.1.0.tar.gz.

File metadata

  • Download URL: bibboost-0.1.0.tar.gz
  • Upload date:
  • Size: 8.8 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: uv/0.8.22

File hashes

Hashes for bibboost-0.1.0.tar.gz
Algorithm Hash digest
SHA256 0761fce0551fe7073107ff450a088a641e1f642f38cd6508dc18820dd0561bab
MD5 743c21aefa42aec1081c596c13988122
BLAKE2b-256 5a553dcb1ec38fec3760d00bde5217b4430845a48f49ab139abaf2ca91b799cd

See more details on using hashes here.

File details

Details for the file bibboost-0.1.0-py3-none-any.whl.

File metadata

  • Download URL: bibboost-0.1.0-py3-none-any.whl
  • Upload date:
  • Size: 9.9 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: uv/0.8.22

File hashes

Hashes for bibboost-0.1.0-py3-none-any.whl
Algorithm Hash digest
SHA256 e5afd9de023536adc9ca90740d44501a3f4bfbab587a12bebb94f396f6fa46e5
MD5 3dfa9eb7761bf6f6dd915b9cd618b93e
BLAKE2b-256 b62ec4f429f70129b2b840becd199c448fad288f27c379545a6d87a4cc12a0e0

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