Skip to main content

A command line tool to get bibtex information from DOIs and PDFs

Project description

kbib: A command line tool to get bibtex information from DOIs and PDFs.

Alt text Alt text Alt text Alt text Alt text Alt text

⚡ Features

  1. Get bibtex information from DOI.
  2. Get bibtex information from article pdf.
  3. Get full list of references of an article as a .bib file.
  4. Directly rename pdf files with bibtex information.

🛠️ Installation

Download and install the latest package from the release section or directly by pip

pip install kbib

For parsing bibtex information from PDF files, optional dependencies need to be installed

pip install kbib['pdf']

🚀 Usage

Use the command line tool kbib as

kbib [-h] [-bib DOI] [-ref DOI] [-pdf [PDF [PDF ...]]] [-ren [PDF [PDF ...]]] [-o DOI]
Argument Description
-bib DOI to get bibtex entry
-ref DOI to get bibtex entries for all the references
-pdf PDF file name(s) to get bibtex info
-ren PDF file name(s) to rename with bibtex info
-o Output bib file
  • Get bibtex from a DOI
    kbib -bib https://doi.org/10xxxxxx
    
  • Get bibtex from a DOI and store in a file 'ref.bib'
    kbib -bib https://doi.org/10xxxxxx -o ref.bib
    
  • Get the full reference list of an article as bibtex entries and save as ref.bib
    kbib -ref https://doi.org/10xxxxxx -o ref.bib
    
  • Get bibtex from a PDF named article.pdf
    kbib -pdf article.pdf
    
  • Get bibtex from all pdfs in the current folder
    kbib -pdf *.pdf
    
  • Rename pdf files with bibtex information
    kbib -ren article.pdf
    # or
    kbib -ren *.pdf
    

⚓Limitation:

  • kbib parses DOI information from Crossref API. So if the article is not indexed in Crossref database this tool will fail to get the necessary information. Also the API may temporarily block requests from an IP if a large number of queries are made within a short period of time.
  • For bibtex keys and renaming files, kbib uses format as <Short Journal Name>_<Volume>_<Year>_<Last name of first author>, which is presently hardcoded in the tool. Therefore, one can not use any desired format through the command line.

⏳ Work-in-Progress:

  • Concurrent/Parallel API calls for faster parsing of bibtex information.

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

kbib-0.1.4.tar.gz (7.1 kB view hashes)

Uploaded Source

Built Distribution

kbib-0.1.4-py3-none-any.whl (8.0 kB view hashes)

Uploaded Python 3

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page