bib_add_keyword.py

#!/usr/bin/env python3
# -*- coding: utf-8; mode: python -*-

"""This script adds one or more keywords to all entries of a bibtex file.

This is a feature that surprisingly no bibtex editor offers."""

__version__ = "1.0"
__date__ = "20181017"
__author__ = "kthoden@mpiwg-berlin.mpg.de"

import argparse
import logging
import bibtexparser
from bibtexparser.bwriter import BibTexWriter
from bibtexparser.bibdatabase import BibDatabase

logging.basicConfig(level=logging.INFO, format=' %(asctime)s - %(levelname)s - %(message)s')

def add_keyword(entry, keyword):
    """Add keyword to bibtex entry"""

    if "keyword" in entry:
        entry["keywords"] = entry["keyword"]
        entry.pop("keyword")
    else:
        logging.info("No keyword found.")

    if "keywords" in entry:
        entry_keywords = entry["keywords"]
        all_keywords = [x.strip() for x in entry_keywords.split(",")]
        if keyword in all_keywords:
            logging.info("Keyword %s already in.", keyword)
        else:
            logging.info("Adding keyword '%s'.", keyword)
            entry["keywords"] = entry_keywords + "," + keyword
    else:
        logging.info("Found no keywords, adding '%s'.", keyword)
        entry["keywords"] = keyword

    return entry
# def add_keyword ends here

def main():
    """The main bit"""

    parser = argparse.ArgumentParser()
    parser.add_argument("-k", "--keyword", help="Assign one or more\
    keywords. Several keyword must be separated by ',' and wrapped in\
    quotes.")
    parser.add_argument("bibtexfile", help="A text file containing a formatted bibliography.")
    args = parser.parse_args()

    with open(args.bibtexfile) as btf:
        btb = bibtexparser.load(btf)

    bib_database = BibDatabase()
    db_list = []

    logging.info("Found %s entries.", len(btb.entries))
    for entry in btb.entries:
        logging.info("========= Entry %s =========", btb.entries.index(entry)+1)
        new_keywords = args.keyword.split(",")
        logging.info("Adding keywords %s", ', '.join(new_keywords))
        for keywords in new_keywords:
            newentry = add_keyword(entry, keywords)

        db_list.append(newentry)

    bib_database.entries = db_list

    bibfile_path = args.bibtexfile.replace(".bib", "-addedkeyword.bib")

    writer = BibTexWriter()
    # indent entries with 4 spaces instead of one
    writer.indent = '    '
    with open(bibfile_path, 'w') as fakebibfile:
        fakebibfile.write(writer.write(bib_database))
    logging.info("Added keywords to entries and wrote %s.", bibfile_path)
# def main ends here

if __name__ == '__main__':
    main()
# finis