Guide

Warning

The English document is not finished yet!

Guidelines for use

Install from PYPI:

pip

pip install --upgrade pdfdeal

conda

conda create -n pdfdeal python=3.11
conda activate pdfdeal
pip install --upgrade pdfdeal

uv

uv venv
source .venv/bin/activate # For Linux
source .venv/Scripts/activate # For Windows
uv pip install --upgrade pdfdeal

Using CLI tools

There is a command line tool, doc2x, which is used to quickly batch process PDFs or images using the Doc2X API.

You can view the help at view help here, or type python -m doc2x -h to view the help.

Doc2X support

You can use the Doc2X-related parts of the library separately, which comes with RPM restrictions, batch processing, and automatic exception handling in addition to request wrapping.

See Doc2X manual for details.

If you want to use the encapsulated asynchronous request function directly, use from pdfdeal.Doc2X.Convert import * to import the function, and refer to this document for function descriptions.

Built-in document processing tools

pdfdeal has some handy built-in file handling tools, such as tools for quickly unzipping zip files, batch renaming, saving a list to PDF, and so on.

Please see Documentation

Processing of PDF files

You can also use offline OCR to process PDF. Currently there is built-in support for easyocr and pytesseract, and you can also customize OCR functions for processing. Note that offline OCR performs poorly on table and formula scenarios.

See documentation.