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.
  5. Find duplicate bib entries in bibtex files.

🛠️ 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 ...]]] [-dup [BIB [BIB ...]]] [-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
-dup Bib/Tex file name(s) to find duplicates.
-o Output bib file

Use cases

  • 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
    
  • Find duplicate bib entries in bibtex files.

    kbib -dup article_1.bib article_2.bib
    
  • If a .tex file is provided, it will find the duplicates that are cited in the tex file

    kbib -dup article.tex article_1.bib article_2.bib
    

⚓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.
  • Special/Latex characters in the title may gets messed up during the API call. One needs to be careful using title field for the bibtex created by kbib.
  • 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.8.tar.gz (8.5 kB view details)

Uploaded Source

Built Distribution

kbib-0.1.8-py3-none-any.whl (9.0 kB view details)

Uploaded Python 3

File details

Details for the file kbib-0.1.8.tar.gz.

File metadata

  • Download URL: kbib-0.1.8.tar.gz
  • Upload date:
  • Size: 8.5 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.2 CPython/3.8.16

File hashes

Hashes for kbib-0.1.8.tar.gz
Algorithm Hash digest
SHA256 1570a98df22c0950ea32c381264499d1208a5157f7493db05b86b90fcdba7dfc
MD5 c2757aabffb76a73ac5d7cad9b719e4d
BLAKE2b-256 b6acf82e5bd6c3d27450c4ac627114ab47a43c3ce6f88382d6c8ff69191ffb03

See more details on using hashes here.

Provenance

File details

Details for the file kbib-0.1.8-py3-none-any.whl.

File metadata

  • Download URL: kbib-0.1.8-py3-none-any.whl
  • Upload date:
  • Size: 9.0 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.2 CPython/3.8.16

File hashes

Hashes for kbib-0.1.8-py3-none-any.whl
Algorithm Hash digest
SHA256 e0dbcfd102ac808c717bf947753243aaa096be401f4b211255f9bb32f2228c55
MD5 a87704f1adf6a10bae7889ab6b16389a
BLAKE2b-256 07d8161179b08ec1cf4049dd74d11c3787f9307f4dd70b2ef419a195e7f0dded

See more details on using hashes here.

Provenance

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