Skip to content

Koushikphy/kbib

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

7 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

kbib: A tool to get bibtex entries from DOIs or PDFs.

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

🐱‍🏍 Installation

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

pip install kbib

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

pip install kbib['pdf']

⚡ Features

  1. Get bibtex entry from DOI.
  2. Get bibtex entry from article pdf.
  3. Get full list of references of an article as bibtex entries.

🚀 Usage

Use the command line tool kbib as

kbib [-h] [-bib DOI] [-ref DOI] [-pdf [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 DOI
-o Output bib file
  1. Get bibtex from a DOI
    kbib -bib https://doi.org/10xxxxxx
  2. Get bibtex from a DOI and store in a file 'ref.bib'
    kbib -bib https://doi.org/10xxxxxx -o ref.bib
  3. 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
  4. Get bibtex from a PDF named article.pdf
    kbib -pdf article.pdf
  5. Get bibtex from all pdf in the current folder
    kbib -pdf *.pdf

⚓Limitation:

Currently it 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.

⚒ Work-in-Progress:

  1. Concurrent API calls for faster parsing of bibtex information.
  2. Set bibtex entry keys in a predefined format.
  3. Ise abbreviated journal names.