refs

Python tools for managing academic references.


License
Other
Install
pip install refs

Documentation

Reference management CLI

Concepts

Bibliography: a set of citations stored in a bib file.

Master bibliography: a bibliography (i.e., bib file) that contains all of your citations, across all papers.

refs file: a file that tracks reference metadata.

Citekey: a unique identifier for each reference.

Usage

Add the citations from the passed bibliography (or bibliographies) to the master bibliography.

refs import BIBLIOGRAPHY...

Add a PDF file to the master bibliography. The metadata of the file will be automatically determined; if it cannot be determined, you will be prompted to enter the missing information. A citekey can optionally be specified; if not specified, it will be generated as authoryear[letter] where [letter] is a letter added to ensure uniqueness.

refs add PDFFILE [CITEKEY] [BIBLIOGRAPHY]

Add one or more citations from the master bibliography to the specified bibliography.

refs add CITEKEY... BIBLIOGRAPHY

Remove one or more citations. If a bibliography is specified, the citation will be removed from the master bibliography.

refs rm CITEKEY... [BIBLIOGRAPHY]

Sort one or more bibliographies by citekey.

refs sort BIBLIOGRAPHY...

Output a bibliography in human-readable format.

refs list BIBLIOGRAPHY

Open a PDF from your bibliography.

refs open CITEKEY [BIBLIOGRAPHY]