# pdf-parser

**Repository Path**: ByteDance/pdf-parser

## Basic Information

- **Project Name**: pdf-parser
- **Description**: No description available
- **Primary Language**: Unknown
- **License**: AGPL-3.0
- **Default Branch**: main
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2025-08-13
- **Last Updated**: 2026-07-04

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# PDF Parser

A HTTP server converting PDF file to text blocks.

This project uses [PyMuPDF](https://pymupdf.readthedocs.io/en/latest/) and complies with its open-source licensing obligations.

## Installation

To use PDF Parser, simply install `hi-pdf-parser` from your package manager, e.g. pip:

```bash
pip install hi-pdf-parser
```

Install the optional server dependencies when running the HTTP server:

```bash
pip install 'hi-pdf-parser[server]'
```

## Developing

### Prepare

Install [uv](https://docs.astral.sh/uv/getting-started/installation/), then:

```bash
uv sync --all-groups --extra server
```

### Coding Style Guidelines

To run the checks on-demand repeatedly until it passes. If you see mypy errors you might need to provide typing hints where requested.

```bash
uv run pre-commit run --all-files
```