ScholarPDF-Renamer

ScholarPDF-Renamer is a tool to automate the extraction of bibliographic information from academic PDF files and rename them according to a standardized format: year_surname of the last author_journal_title.

How does it work?

The scirpt extracts the DOI or arXiv IDs from the pdf file and retrieves the necessary data from online bibliographic databases.

How to Get Started?

Prerequisites

• Python 3.11.7 or higher, preferably installed via Anaconda.
• Internet connection to access online databases.

Using the Script

To use the Python script directly, install the required packages using pip first:

pip install pdfminer.six
pip install PyPDF2
pip install requests

Then:

python scholarpdf_renamer.py

Note: Running the python script outside of an Integrated Development Environment (IDE) may result in no visible status updates, which can be inconvenient. For a better user experience, it is recommended to execute the script within an IDE, where you can see real-time updates.

Alternatively, it would be appreciated if you could modify the script to include a status window.

For Windows users, an executable file is provided and no installation is required. The script's status updates will be displayed in a terminal window.

Known Issues

1. PDF Compatibility:
   The script is unable to process PDF files that lack a DOI or an arXiv ID.
   Additionally, it may occasionally fail to recognize the arXiv ID in some documents.
2. Performance Note:
   The script requires access to an online database, which can cause delays that may seem as if the application has become unresponsive.
   Please be patient during these periods, as the script is actively downloading the necessary information from the database.

Contribution and Maintenance

Contributors: OwenLiu04, Hangyu Ge.

For issues and support, please contact the maintainers via email at [email protected] or open an issue in this repository.

If you're interested in helping us improve ScholarPDF-Renamer, please feel free to contribute!