https://github.com/samuelmarks/bibtex-auto-annotate

BibTeX auto annotator
https://github.com/samuelmarks/bibtex-auto-annotate

Last synced: over 1 year ago
JSON representation

BibTeX auto annotator

• Host: GitHub
• URL: https://github.com/samuelmarks/bibtex-auto-annotate
• Owner: SamuelMarks
• Created: 2017-03-26T00:06:16.000Z (over 9 years ago)
• Default Branch: master
• Last Pushed: 2017-06-14T07:17:35.000Z (about 9 years ago)
• Last Synced: 2025-01-28T04:32:02.529Z (over 1 year ago)
• Language: Python
• Size: 17.6 KB
• Stars: 0
• Watchers: 3
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

          
bibtex_auto_annotate

====================

BibTeX auto annotator. Uses [Crossref](https://www.crossref.org)'s and arXiv's APIs.

## Features

Annotates all BibTeX records with:

  - [DOI](https://en.wikipedia.org/wiki/Digital_object_identifier)s (via CrossRef's API)

  - [eprint](https://arxiv.org/hypertex/bibstyles/)s (via arXiv's API)

## Installation

Ensure [Python](https://www.python.org/downloads) and [`pip`](https://pip.pypa.io/en/stable/installing) are installed, then from your command-line interface run:

    pip install https://api.github.com/repos/SamuelMarks/bibtex-auto-annotate/zipball#egg=bibtex_auto_annotate

## Usage

    python -m bibtex_auto_annotate -h

    usage: bibtex_auto_annotate [-h] [-v] [-f FILE] [-o OUTFILE]  [-r RETRY]

    BibTeX auto annotator

    

    optional arguments:

      -h, --help            show this help message and exit

      -v, --version         show program's version number and exit

      -f FILE, --files FILE

                            One or more BibTeX files. Accepts * as wildcard for

                            directories or filenames

      -o OUTFILE, --output-file OUTFILE

                            Output BibTeX file

      -r RETRY, --retry RETRY

                            Retry times (for CrossRef API). [Default: 5]

## Development

Tested with Python 2.7. Should work on Python 3+ also.

### Install dependencies

    pip install -r requirements.txt

### Install package

    pip install .

### Test package

    python setup.py test

### TODO

  - Finish implementing glob support

  - Implement multiple output files, and putting multiple input files into one output

  - in-place output