Skip to main content

A CLI tool for searching, downloading, parsing, and summarizing academic papers.

Project description

Paper Parser 🛠️

Efficient arXiv Search, Download, and AI-Friendly Markdown Parsing.

paper-parser is a CLI tool designed to streamline the academic research workflow. It handles everything from finding a paper on arXiv to converting it into a clean, structured Markdown format that is optimized for LLMs and AI agents.

🚀 Why Use Paper Parser?

Standard PDF-to-text tools often produce one massive block of text, which leads to two major problems when working with AI:

  1. Context Overflow: Large papers can exceed an LLM's context window.
  2. Token Waste: Paying for the entire paper's context when you only need to analyze the "Methodology" or "Conclusion" is expensive and slow.

The Solution: paper-parser uses the MinerU V4 API to extract high-quality Markdown and then automatically splits the paper into chapters. This allows AI agents to read the paper section-by-section, enabling:

  • Granular Context Management: Only read what matters.
  • Significant Token Savings: Drastically reduce your API bills.
  • Higher Accuracy: Focus the model's attention on specific sections.

✨ Key Features

  • 🔍 Intelligent Search: Typos? No problem. Fuzzy-searches arXiv with relevance ranking.
  • 📥 Smart Download: Downloads PDFs into organized, ID-based directories.
  • 🧩 Section Splitting: Automatically splits papers into 01_Introduction.md, 02_Methodology.md, etc.
  • 📦 Incremental Processing: Remembers what you've already downloaded and parsed—no redundant API calls.
  • 🖼️ Image Extraction: Extracts images and maintains correct relative links within the Markdown chapters.
  • 📝 Note Templates: Automatically generates title.md and summary.md for your research notes.

🛠️ Installation

From PyPI (Recommended)

pip install paper-parser-skill

From Source

# Clone the repository
git clone https://github.com/KaiHangYang/paper-parser-skill.git
cd paper-parser-skill

# Install in editable mode
pip install -e .

⚙️ Configuration

The first time you run pp, it will create a configuration file at ~/.paper-parser/config.yaml.

MINERU_API_TOKEN: "your_token_from_mineru.net"
PAPER_WORKSPACE: "~/paper-parser-workspace"
MINERU_API_TIMEOUT: 600

[!IMPORTANT] You need an API token from MinerU to use the parsing features.


📖 Usage Guide

# 1. Search for a paper
pp search "LLaMA 3"

# 2. Complete workflow: Search -> Download -> Parse -> Meta
pp all "2303.17564"

# 3. Parse a local PDF file
pp parse ./my_local_paper.pdf

# 4. Find where a paper is stored
pp path "LLaMA"

📂 Output Structure

PAPER_WORKSPACE/
└── 2303.17564/              # ArXiv ID
    ├── paper.pdf            # Original PDF
    ├── title.md             # Paper metadata
    ├── summary.md           # Note-taking template
    └── markdowns/           # AI-Ready Content
        ├── 01_Introduction.md
        ├── 02_Methods.md
        ├── ...
        └── images/          # Extracted figures & tables

🤝 Acknowledgments

📜 License

MIT

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

paper_parser_skill-0.1.1.tar.gz (11.1 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

paper_parser_skill-0.1.1-py3-none-any.whl (11.5 kB view details)

Uploaded Python 3

File details

Details for the file paper_parser_skill-0.1.1.tar.gz.

File metadata

  • Download URL: paper_parser_skill-0.1.1.tar.gz
  • Upload date:
  • Size: 11.1 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.12

File hashes

Hashes for paper_parser_skill-0.1.1.tar.gz
Algorithm Hash digest
SHA256 c3e1800355cdc8b3b4f5f688e2ae9dfb82082f40047077476f49f6abb699e716
MD5 b8cee90819dbbd3b09da21977667b9ae
BLAKE2b-256 85e21bdc4b226e0cfd99dafc6fedbe5b60666ca11d95327c73f380ee460e5ca1

See more details on using hashes here.

Provenance

The following attestation bundles were made for paper_parser_skill-0.1.1.tar.gz:

Publisher: publish.yml on KaiHangYang/paper-parser-skill

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file paper_parser_skill-0.1.1-py3-none-any.whl.

File metadata

File hashes

Hashes for paper_parser_skill-0.1.1-py3-none-any.whl
Algorithm Hash digest
SHA256 2758e7680bb7803a1623553130e5b93357f65f03b7b26bdbd7b221b34460de6e
MD5 6c5656ce791e2715204cebb6b6aeac41
BLAKE2b-256 ee1d7e7e116228b40a4cd8173189290e5193bb2e477637b2c2b0cc7d8cd044eb

See more details on using hashes here.

Provenance

The following attestation bundles were made for paper_parser_skill-0.1.1-py3-none-any.whl:

Publisher: publish.yml on KaiHangYang/paper-parser-skill

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page