Skip to main content

Check your BibTeX files for consistency and sanity.

Project description

BibCheX is a tool to sanity- and consistency-check your BibTeX reference files. Aside from checks ensuring your preferred style guidelines are met, Bibchex pulls in bibliographic data from sources such as CrossRef and cross-checks your BibTeX files against this data. The documentation contains a list of all available checkers and data sources.

Getting started

This walks you quickly through running BibCheX on your .bib file.

Installation

Installing BibCheX from source should be as easy as running

python setup.py install

in the source folder. Alternatively, you can install BibCheX from PyPI using pip:

pip install bibchex

Configuration

Configuration determines which style rules should be checked for. BibCheX comes with a default configuration which matches my personal taste, but probably not yours. So you can run BibCheX without customizing the config, but you might not be happy with the result.

You can find the default configuration at bibchex/data/default_config.json in the source. Copy that file to ~/.config/bibchex.json or anywhere else. If you did copy it to some arbitrary location, you must pass the path to that file via the --config command line switch.

Have a look at the configuration documentation to see what can be configured.

Running

BibCheX can be run in three modes. In GUI mode, text mode or silent mode. Okay, “GUI” is kind of a lie, it’s more of a TUI. But anyways, it provides progress bars, so yay for GUI mode!

BibCheX expects as first positional argument the path to your .bib file, and as second a path to a (non-existent) HTML file, to which it will write its output. Running BibCheX (in GUI mode) can be as easy as:

bibchex /path/to/my/references.bib /path/to/the/desired/output.html

This should open a text UI with some scrolling log messages and progress bars on the top. Once everything is finished, press any key to close the UI and open /path/to/the/desired/output.html in any browser to have a look at the result.

Running BibCheX without the GUI can be done like this:

bibchex --cli /path/to/my/references.bib /path/to/the/desired/output.html

Remember that you may have to pass your custom configuration JSON file if you have placed in a nonstandard location:

bibchex --cli --config /path/to/your/config.json /path/to/my/references.bib /path/to/the/desired/output.html

Please Note: The (free) crossref API required a valid email address to be set for usage. By default, a dummy address is configured. Please change this to a valid address before actually using BibCheX!

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

bibchex-0.1.6.tar.gz (27.8 kB view details)

Uploaded Source

Built Distribution

bibchex-0.1.6-py3-none-any.whl (36.7 kB view details)

Uploaded Python 3

File details

Details for the file bibchex-0.1.6.tar.gz.

File metadata

  • Download URL: bibchex-0.1.6.tar.gz
  • Upload date:
  • Size: 27.8 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.1.1 pkginfo/1.5.0.1 requests/2.22.0 setuptools/41.6.0 requests-toolbelt/0.9.1 tqdm/4.46.1 CPython/3.6.8

File hashes

Hashes for bibchex-0.1.6.tar.gz
Algorithm Hash digest
SHA256 e38c39e6905154b23e1689f9f5b10093ebdfe1caebbad54ab6dc3789e0a53268
MD5 a43d7b9db737def0828ccdd4f9e412d0
BLAKE2b-256 d69fd9808956e9166fc61daa003ec7ed34a587395d48d1c31cbd5999a23e3918

See more details on using hashes here.

File details

Details for the file bibchex-0.1.6-py3-none-any.whl.

File metadata

  • Download URL: bibchex-0.1.6-py3-none-any.whl
  • Upload date:
  • Size: 36.7 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.1.1 pkginfo/1.5.0.1 requests/2.22.0 setuptools/41.6.0 requests-toolbelt/0.9.1 tqdm/4.46.1 CPython/3.6.8

File hashes

Hashes for bibchex-0.1.6-py3-none-any.whl
Algorithm Hash digest
SHA256 3890f526c6a55222b19e33f2369d20b195cd1cde5fcc2e740ffaed399128c268
MD5 bed19d43d2a5fb05f309f4ce23b107c4
BLAKE2b-256 db7ad97179b0ca1106e7e538a1082cab07d013a148473701c6678a018326b0bb

See more details on using hashes here.

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