sci-paper-rename

KO | EN

gitlite — search

#typescript #ai-agents #ai #dsh-plugin #deepseek-harness #open-source #cli #claude-code #codex #developer-tools #react #windows

sci-paper-rename

★ 35 Open GitHub ↗

A simple CLI tool to rename scientific papers based on their titles.

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

# Scientific Paper Rename (sci-paper-rename)

Tired of messy filenames for all your scientific papers? **sci-paper-rename** is
here to help! This handy command-line tool automatically renames your PDFs using
their actual paper titles — no more guesswork or manual renaming.

Just run it on your folder of papers, and watch it tidy up your files with neat,
meaningful names. Easy, fast, and stress-free!

## Introduction

Scientific Paper Rename (or **sci-paper-rename**, for short) is a command-line
tool that makes organizing your scientific papers a breeze. It scans each PDF to
find the paper’s title and then renames the file to match — so your folders stay
neat and easy to navigate.

## Approach

**_sci-paper-rename_** looks for the title in two places:

1. **PDF Metadata**: If the PDF was carefully created, the title might be stored
   in its metadata.
2. **Largest Font on First Page**: If metadata is unavailable or unreliable, the
   tool scans the first page of the paper, looking for a sentence with the
   **largest font size**, assuming it's the title.

If both methods succeed, the user is prompted to choose which title to use.

## Dependencies

The current version depends on **Python 3.11.6** and **PyMuPDF 1.26.0**. Please
make sure to have them installed before running the package!

If your version doesn't match, use [pyenv](https://github.com/pyenv/pyenv) to
install and switch to a virtual environment with Python version 3.11.6.

### TLDR: pyenv

- **Installing pyenv**: check pyenv installation instructions
  [here](https://github.com/pyenv/pyenv?tab=readme-ov-file#installation)

- **Using pyenv**: check how to use pyenv
  [here](https://github.com/pyenv/pyenv?tab=readme-ov-file#usage)

## Installation

Once you have the right version of Python installed, you can install
**sci-paper-rename** easily with pip:

### From [PyPI](https://pypi.org/project/sci-paper-rename/)

```bash
pip install sci-paper-rename
```

### From GitHub repository (latest development version)

```bash
pip install git+https://github.com/heversonbr/sci-paper-rename.git
```

### Or, if you have Python 3.11.6 already installed and prefer to install locally by cloning

```bash
git clone https://github.com/heversonbr/sci-paper-rename.git
cd sci-paper-rename
python3 -m venv .venv
source .venv/bin/activate
pip install --upgrade pip
pip install .
```

## Usage

After installation, use the tool from the command line.

**Rename all files in a directory**

```bash
python3 sci-paper-rename.py </path/to/target_directory>
```

**Rename a single PDF file**

```bash
sci-paper-rename /path/to/specific-paper.pdf
```

**Show help message**

```bash
sci-paper-rename --help
```

sci-paper-rename

Explore Similar Repositories

Was this content helpful?

Recent Feedback

Download README