BibTeXManager
Automatical DOI Fetching and DOI Formatting
Install / Use
/learn @ClaireGyn/BibTeXManagerREADME
BibTeXManager
BibTeXManager is a Python utility designed to automate the enhancement of BibTeX files by fetching and adding missing Digital Object Identifiers (DOIs) to bibliography entries. This tool is especially useful for academic and scientific writing where referencing DOI-enabled citations is necessary for the reproducibility and accessibility of cited resources.
Features
- DOI Fetching: Automatically fetches DOIs for BibTeX entries using the Crossref API.
- DOI Formatting: Ensures DOIs are formatted as clickable URLs.
Prerequisites
Before you start using BibTeXManager, make sure you have Python installed on your system. Python 3.6 or above is recommended. You also need to install the requests and bibtexparser libraries, which can be installed via pip:
python -m pip install -r requirements.txt
Installation
Clone this repository to your local machine:
git clone https://github.com/ClaireGyn/BibTeXManager.git
cd BibTeXManager
Usage
Run the script by executing the following command in your terminal. You will be prompted to enter the absolute paths for your input and output
.bib files:
python bibtex_manager.py
This command will process the specified BibTeX file, fetch missing DOIs, and save the updated entries to the output file.
Script Configuration
Before running the script, you will need to set up the configuration by specifying the paths for your input and output files. Follow the steps below to configure the script:
-
Input Path: When prompted, enter the absolute path of your old
.bibfile. This is the file that you want to update. -
Output Path: Enter the absolute path for the output
.bibfile where the updated version will be saved.
After entering these paths, the script will initialize a BibTeXManager with these paths and proceed to update the .bib file by fetching and updating DOI (Digital Object Identifier) information where applicable.
Contributing
Contributions to BibTeXManager are welcome! Here are a few ways you can help:
- Report bugs and issues.
- Suggest new features or improvements.
- Spread the word about
BibTeXManager.
Please fork the repository and submit pull requests for your proposed changes.
License
BibTeXManager is released under the MIT License.
Contact
For questions or support, please contact yaonangu@u.nus.edu.
