Skip to main content

Better BibTeX data

Project description

betterbib

CircleCI codecov Codacy grade Code style: black awesome PyPi Version GitHub stars

BibTeX files are typically manually maintained and thus often contain inconsistencies, mistakes, or are missing information. betterbib helps maintaining your BibTeX files by comparing them with online sources and correcting whatever entries are found faulty.

Simply run

betterbib in.bib out.bib

to improve your BibTeX file with default settings. For example, the input BibTeX

@article {krylov,
  author = {Liesen and Gaul and Nabben},
  title = {Framework Deflation Krylov Augmented}
}

is converted to

@article{krylov,
 author = {Gaul, André and Gutknecht, Martin H. and Liesen, Jörg and Nabben, Reinhard},
 title = {A Framework for Deflated and Augmented {Krylov} Subspace Methods},
 doi = {10.1137/110820713},
 number = {2},
 pages = {495-518},
 source = {Crossref},
 url = {https://doi.org/10.1137/110820713},
 volume = {34},
 journal = {SIAM J. Matrix Anal. & Appl.},
 publisher = {Society for Industrial & Applied Mathematics (SIAM)},
 issn = {0895-4798, 1095-7162},
 year = {2013},
 month = jan,
}

Tools

All of the following tools can read from standard input and write to standard output, so you can concatenate them to get exactly what you want. For example, the above betterbib command is short for

betterbib-sync in.bib | betterbib-journal-abbrev | betterbib-format -b - out.bib

Sync

betterbib fetches data from

All betterbib-sync command-line options are explained in betterbib-sync -h.

Format

The tool

betterbib-format in.bib out.bib

allows you to apply consistent formatting to you BibTeX file. See -h/--help for options.

(Un)abbreviate journal names

The tool

betterbib-journal-abbrev in.bib out.bib

allows you to apply consistent abbreviation of journal names. See -h/--help for options.

Configuration

In BibTeX titles, some words need to be protected by curly brackets such that they are capitalized correctly, e.g., {Einstein}. betterbib automatically recognizes some of them (if they are in the default dictionary, like Einstein), but you might want to add some. To this end, create the config file

~/.config/betterbib/config.ini

and fill it with, e.g.,

[DICTIONARY]
add=Arnoldi,
    Bernstein,
    Boolean,
    Chebyshev,
    Hermitian

remove=hermitian,
   boolean

Installation

betterbib is available from the Python Package Index, so simply do

pip install -U betterbib

to install or upgrade. Use sudo -H to install as root or the --user option of pip to install in $HOME.

Testing

To run the betterbib unit tests, check out this repository and type

pytest

Distribution

To create a new release

  1. bump the __version__ number,

  2. publish to PyPi and tag on GitHub:

    $ make publish
    

License

betterbib is published under the MIT license.

Project details


Release history Release notifications

This version
History Node

3.3.2

History Node

3.3.1

History Node

3.3.0

History Node

3.2.4

History Node

3.2.3

History Node

3.2.2

History Node

3.2.1

History Node

3.2.0

History Node

3.1.3

History Node

3.1.2

History Node

3.1.1

History Node

3.1.0

History Node

3.0.3

History Node

3.0.2

History Node

3.0.1

History Node

3.0.0

History Node

2.5.5

History Node

2.5.3

History Node

2.5.2

History Node

2.5.1

History Node

2.5.0

History Node

2.4.2

History Node

2.4.1

History Node

2.4.0

History Node

2.3.7

History Node

2.3.6

History Node

2.3.5

History Node

2.3.4

History Node

2.3.3

History Node

2.3.2

History Node

2.3.1

History Node

2.3.0

History Node

2.2.1

History Node

2.2.0

History Node

2.1.6

History Node

2.1.5

History Node

2.1.4

History Node

2.1.3

History Node

2.1.2

History Node

2.1.1

History Node

2.1.0

History Node

2.0.2

History Node

2.0.1

History Node

2.0.0

History Node

1.1.2

History Node

1.1.1

History Node

1.1.0

History Node

1.0.0

History Node

0.4.0

History Node

0.3.1

History Node

0.3.0

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Filename, size & hash SHA256 hash help File type Python version Upload date
betterbib-3.3.2-py2.py3-none-any.whl (237.9 kB) Copy SHA256 hash SHA256 Wheel py2.py3 Jun 20, 2018
betterbib-3.3.2.tar.gz (237.2 kB) Copy SHA256 hash SHA256 Source None Jun 20, 2018

Supported by

Elastic Elastic Search Pingdom Pingdom Monitoring Google Google BigQuery Sentry Sentry Error logging CloudAMQP CloudAMQP RabbitMQ AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN DigiCert DigiCert EV certificate StatusPage StatusPage Status page