Skip to main content

The world's highest performing e-book retention layout translation library

Project description

English | 简体中文 | 繁體中文 | 日本語 | 한국어

PolyglotPDF

Python PDF LaTeX Translation Math PyMuPDF

Demo

Speed comparison

🎬 Watch Full Video

llms has been added as the translation api of choice, Doubao ,Qwen ,deepseek v3 , gpt4-o-mini are recommended. The color space error can be resolved by filling the white areas in PDF files. The old text to text translation api has been removed.

In addition, consider adding arxiv search function and rendering arxiv papers after latex translation.

Pasges show

Chinese LLM API Application

Doubao & Deepseek

Apply through Volcengine platform:

  • Application URL: Volcengine-Doubao
  • Available Models: Doubao, Deepseek series models

Tongyi Qwen

Apply through Alibaba Cloud platform:

Overview

PolyglotPDF(EbookTranslation) is an advanced PDF processing tool that employs specialized techniques for ultra-fast text, table, and formula recognition in PDF documents, typically completing processing within 1 second. It features OCR capabilities and layout-preserving translation, with full document translations usually completed within 10 seconds (speed may vary depending on the translation API provider).

Features

  • Ultra-Fast Recognition: Processes text, tables, and formulas in PDFs within ~1 second
  • Layout-Preserving Translation: Maintains original document formatting while translating content
  • OCR Support: Handles scanned documents efficiently
  • Text-based PDF:No GPU required
  • Quick Translation: Complete PDF translation in approximately 10 seconds
  • Flexible API Integration: Compatible with various translation service providers
  • Web-based Comparison Interface: Side-by-side comparison of original and translated documents
  • Enhanced OCR Capabilities: Improved accuracy in text recognition and processing
  • Support for offline translation: Use smaller translation model

Installation and Setup

There are several ways to use it. One is to install the library,

pip install EbookTranslator

Basic usage:

EbookTranslator your_file.pdf

Usage with parameters:

EbookTranslator your_file.pdf -o en -t zh -b 1 -e 10 -c /path/to/config.json -d 300

Using in Python Code

from EbookTranslator import main_function

translator = main_function(
    pdf_path="your_file.pdf",
    original_language="en",
    target_language="zh",
    bn=1,
    en=10,
    config_path="/path/to/config.json",
    DPI=300
)
translator.main()

Parameter Description

Parameter Command Line Option Description Default Value
pdf_path Positional argument PDF file path Required
original_language -o, --original Source language auto
target_language -t, --target Target language zh
bn -b, --begin Starting page number 1
en -e, --end Ending page number Last page of the document
config_path -c, --config Configuration file path config.json in the current working directory
DPI -d, --dpi DPI for OCR mode 72

Configuration File

The configuration file is a JSON file, by default located at config.json in the current working directory. If it doesn't exist, the program will use built-in default settings.

Configuration File Example

{
  "count": 4,
  "PPC": 20,
  "translation_services": {
    "Doubao": {
      "auth_key": "",
      "model_name": ""
    },
    "Qwen": {
      "auth_key": "",
      "model_name": "qwen-plus"
    },
    "deepl": {
      "auth_key": ""
    },
    "deepseek": {
      "auth_key": "",
      "model_name": "ep-20250218224909-gps4n"
    },
    "openai": {
      "auth_key": "",
      "model_name": "gpt-4o-mini"
    },
    "youdao": {
      "app_key": "",
      "app_secret": ""
    }
  },
  "ocr_services": {
    "tesseract": {
      "path": "C:\\Program Files\\Tesseract-OCR\\tesseract.exe"
    }
  },
  "default_services": {
    "ocr_model": false,
    "line_model": false,
    "Enable_translation": true,
    "Translation_api": "openai"
  }
}

Configuration Options

  • translation_service: Translation service provider (e.g., "google", "deepl", "baidu")
  • api_key: Translation API key (if required)
  • translation_mode: Translation mode, "online" or "offline"
  • ocr_enabled: Whether to enable OCR recognition
  • tesseract_path: Path to Tesseract OCR engine (if not in system PATH)
  • output_dir: Output directory
  • language_codes: Language code mapping
  • font_mapping: Fonts corresponding to different languages

Output

Translated PDF files will be saved in the directory specified by output_dir (default is the target folder in the current working directory).

License

MIT

Use method for friendly UI interface

  1. Clone the repository:
git clone https://github.com/CBIhalsen/PolyglotPDF.git
cd polyglotpdf
  1. Install required packages:
pip install -r requirements.txt
  1. Configure your API key in config.json. The alicloud translation API is not recommended.

  2. Run the application:

python app.py
  1. Access the web interface: Open your browser and navigate to http://127.0.0.1:8000

Requirements

  • Python 3.8+
  • deepl==1.17.0
  • Flask==2.0.1
  • Flask-Cors==5.0.0
  • langdetect==1.0.9
  • Pillow==10.2.0
  • PyMuPDF==1.24.0
  • pytesseract==0.3.10
  • requests==2.31.0
  • tiktoken==0.6.0
  • Werkzeug==2.0.1

Acknowledgments

This project leverages PyMuPDF's capabilities for efficient PDF processing and layout preservation.

Upcoming Improvements

  • PDF chat functionality
  • Academic PDF search integration
  • Optimization for even faster processing speeds

Known Issues

  • Issue Description: Error during text re-editing: code=4: only Gray, RGB, and CMYK colorspaces supported
  • Symptom: Unsupported color space encountered during text block editing
  • Current Workaround: Skip text blocks with unsupported color spaces
  • Proposed Solution: Switch to OCR mode for entire pages containing unsupported color spaces
  • Example: View PDF sample with unsupported color spaces

Font Optimization

Current font configuration in the start function of main.py:

# Current configuration
css=f"* {{font-family:{get_font_by_language(self.target_language)};font-size:auto;color: #111111 ;font-weight:normal;}}"

You can optimize font display through the following methods:

  1. Modify Default Font Configuration
# Custom font styles
css=f"""* {{
    font-family: {get_font_by_language(self.target_language)};
    font-size: auto;
    color: #111111;
    font-weight: normal;
    letter-spacing: 0.5px;  # Adjust letter spacing
    line-height: 1.5;      # Adjust line height
}}"""
  1. Embed Custom Fonts You can embed custom fonts by following these steps:
  • Place font files (.ttf, .otf) in the project's fonts directory
  • Use @font-face to declare custom fonts in CSS
css=f"""
@font-face {{
    font-family: 'CustomFont';
    src: url('fonts/your-font.ttf') format('truetype');
}}
* {{
    font-family: 'CustomFont', {get_font_by_language(self.target_language)};
    font-size: auto;
    font-weight: normal;
}}
"""

Basic Principles

This project follows similar basic principles as Adobe Acrobat DC's PDF editing, using PyMuPDF for text block recognition and manipulation:

  • Core Process:
# Get text blocks from the page
blocks = page.get_text("dict")["blocks"]

# Process each text block
for block in blocks:
    if block.get("type") == 0:  # text block
        bbox = block["bbox"]     # get text block boundary
        text = ""
        font_info = None
        # Collect text and font information
        for line in block["lines"]:
            for span in line["spans"]:
                text += span["text"] + " "

This approach directly processes PDF text blocks, maintaining the original layout while achieving efficient text extraction and modification.

  • Technical Choices:

    • Utilizes PyMuPDF for PDF parsing and editing
    • Focuses on text processing
    • Avoids complex operations like AI formula recognition, table processing, or page restructuring
  • Why Avoid Complex Processing:

    • AI recognition of formulas, tables, and PDF restructuring faces severe performance bottlenecks
    • Complex AI processing leads to high computational costs
    • Significantly increased processing time (potentially tens of seconds or more)
    • Difficult to deploy at scale with low costs in production environments
    • Not suitable for online services requiring quick response times
  • Project Scope:

    • This project only serves to demonstrate the correct approach for layout-preserved PDF translation and AI-assisted PDF reading. Converting PDF files to markdown format for large language models to read, in my opinion, is not a wise approach.
    • Aims for optimal performance-to-cost ratio
  • Performance:

    • PolyglotPDF API response time: ~1 second per page
    • Low computational resource requirements, suitable for scale deployment
    • High cost-effectiveness for commercial applications

Related questions answered and discussed:

QQ group: 1031477425

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

EbookTranslator-0.3.3.tar.gz (38.7 kB view details)

Uploaded Source

Built Distribution

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

EbookTranslator-0.3.3-py3-none-any.whl (37.2 kB view details)

Uploaded Python 3

File details

Details for the file EbookTranslator-0.3.3.tar.gz.

File metadata

  • Download URL: EbookTranslator-0.3.3.tar.gz
  • Upload date:
  • Size: 38.7 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.9.7

File hashes

Hashes for EbookTranslator-0.3.3.tar.gz
Algorithm Hash digest
SHA256 f69702f4064fc71af05f60bb1864c890dde09a60c0d29068e5db2d4251f44e6f
MD5 55090a135e94c9ca866da01073b4ea22
BLAKE2b-256 3287100b37e318ee8899e0e18b581411f2bc9a8c9911e72b8cf76755d94a0fd8

See more details on using hashes here.

File details

Details for the file EbookTranslator-0.3.3-py3-none-any.whl.

File metadata

File hashes

Hashes for EbookTranslator-0.3.3-py3-none-any.whl
Algorithm Hash digest
SHA256 baf26bf9a91ba6d367ed7b5b2e42047ce64fe3638688d3d08770ddffdba26d43
MD5 a5e600fdb8c9ee257d13ef2bf875ebb8
BLAKE2b-256 99b860f909cdd50f2651160f6cbf3705e2f811d7cd21f5ef37b262c777de07e1

See more details on using hashes here.

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