| Name | pdf2zh JSON |
| Version |
1.9.11
JSON |
| download |
| home_page | None |
| Summary | Latex PDF Translator |
| upload_time | 2025-07-11 08:35:46 |
| maintainer | None |
| docs_url | None |
| author | None |
| requires_python | <3.13,>=3.10 |
| license | None |
| keywords |
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
<div align="center">
English | [简体中文](docs/README_zh-CN.md) | [繁體中文](docs/README_zh-TW.md) | [日本語](docs/README_ja-JP.md) | [한국어](docs/README_ko-KR.md)
<img src="./docs/images/banner.png" width="320px" alt="PDF2ZH"/>
<h2 id="title">PDFMathTranslate</h2>
<p>
<!-- PyPI -->
<a href="https://pypi.org/project/pdf2zh/">
<img src="https://img.shields.io/pypi/v/pdf2zh"></a>
<a href="https://pepy.tech/projects/pdf2zh">
<img src="https://static.pepy.tech/badge/pdf2zh"></a>
<a href="https://hub.docker.com/repository/docker/byaidu/pdf2zh">
<img src="https://img.shields.io/docker/pulls/byaidu/pdf2zh"></a>
<a href="https://hellogithub.com/repository/8ec2cfd3ef744762bf531232fa32bc47" target="_blank"><img src="https://api.hellogithub.com/v1/widgets/recommend.svg?rid=8ec2cfd3ef744762bf531232fa32bc47&claim_uid=JQ0yfeBNjaTuqDU&theme=small" alt="Featured｜HelloGitHub" /></a>
<a href="https://gitcode.com/Byaidu/PDFMathTranslate/overview">
<img src="https://gitcode.com/Byaidu/PDFMathTranslate/star/badge.svg"></a>
<a href="https://huggingface.co/spaces/reycn/PDFMathTranslate-Docker">
<img src="https://img.shields.io/badge/%F0%9F%A4%97-Online%20Demo-FF9E0D"></a>
<a href="https://www.modelscope.cn/studios/AI-ModelScope/PDFMathTranslate">
<img src="https://img.shields.io/badge/ModelScope-Demo-blue"></a>
<a href="https://github.com/Byaidu/PDFMathTranslate/pulls">
<img src="https://img.shields.io/badge/contributions-welcome-green"></a>
<a href="https://t.me/+Z9_SgnxmsmA5NzBl">
<img src="https://img.shields.io/badge/Telegram-2CA5E0?style=flat-squeare&logo=telegram&logoColor=white"></a>
<!-- License -->
<a href="./LICENSE">
<img src="https://img.shields.io/github/license/Byaidu/PDFMathTranslate"></a>
</p>
<a href="https://trendshift.io/repositories/12424" target="_blank"><img src="https://trendshift.io/api/badge/repositories/12424" alt="Byaidu%2FPDFMathTranslate | Trendshift" style="width: 250px; height: 55px;" width="250" height="55"/></a>
</div>
PDF scientific paper translation and bilingual comparison.
- 📊 Preserve formulas, charts, table of contents, and annotations _([preview](#preview))_.
- 🌐 Support [multiple languages](#language), and diverse [translation services](#services).
- 🤖 Provides [commandline tool](#usage), [interactive user interface](#gui), and [Docker](#docker)
Feel free to provide feedback in [GitHub Issues](https://github.com/Byaidu/PDFMathTranslate/issues) or [Telegram Group](https://t.me/+Z9_SgnxmsmA5NzBl).
For details on how to contribute, please consult the [Contribution Guide](https://github.com/Byaidu/PDFMathTranslate/wiki/Contribution-Guide---%E8%B4%A1%E7%8C%AE%E6%8C%87%E5%8D%97).
<h2 id="updates">Updates</h2>
- [May 9, 2025] pdf2zh 2.0 Preview Version [#586](https://github.com/Byaidu/PDFMathTranslate/issues/586): The Windows ZIP file and Docker image are now available.
> [!NOTE]
>
> 2.0 Moved to a new repository under the organization: [PDFMathTranslate/PDFMathTranslate-next](https://github.com/PDFMathTranslate/PDFMathTranslate-next)
>
> Version 2.0 official release has been published.
- [Mar. 3, 2025] Experimental support for the new backend [BabelDOC](https://github.com/funstory-ai/BabelDOC) WebUI added as an experimental option (by [@awwaawwa](https://github.com/awwaawwa))
- [Feb. 22 2025] Better release CI and well-packaged windows-amd64 exe (by [@awwaawwa](https://github.com/awwaawwa))
- [Dec. 24 2024] The translator now supports local models on [Xinference](https://github.com/xorbitsai/inference) _(by [@imClumsyPanda](https://github.com/imClumsyPanda))_
- [Dec. 19 2024] Non-PDF/A documents are now supported using `-cp` _(by [@reycn](https://github.com/reycn))_
- [Dec. 13 2024] Additional support for backend by _(by [@YadominJinta](https://github.com/YadominJinta))_
- [Dec. 10 2024] The translator now supports OpenAI models on Azure _(by [@yidasanqian](https://github.com/yidasanqian))_
<h2 id="preview">Preview</h2>
<div align="center">
<img src="./docs/images/preview.gif" width="80%"/>
</div>
<h2 id="demo">Online Service 🌟</h2>
You can try our application out using either of the following demos:
- [Public free service](https://pdf2zh.com/) online without installation _(recommended)_.
- [Immersive Translate - BabelDOC](https://app.immersivetranslate.com/babel-doc/) 1000 free pages per month. _(recommended)_
- [Demo hosted on HuggingFace](https://huggingface.co/spaces/reycn/PDFMathTranslate-Docker)
- [Demo hosted on ModelScope](https://www.modelscope.cn/studios/AI-ModelScope/PDFMathTranslate) without installation.
Note that the computing resources of the demo are limited, so please avoid abusing them.
<h2 id="install">Installation and Usage</h2>
### Methods
For different use cases, we provide distinct methods to use our program:
<details open>
<summary>1. UV install</summary>
1. Python installed (3.10 <= version <= 3.12)
2. Install our package:
```bash
pip install uv
uv tool install --python 3.12 pdf2zh
```
3. Execute translation, files generated in [current working directory](https://chatgpt.com/share/6745ed36-9acc-800e-8a90-59204bd13444):
```bash
pdf2zh document.pdf
```
</details>
<details>
<summary>2. Windows exe</summary>
1. Download pdf2zh-version-win64.zip from [release page](https://github.com/Byaidu/PDFMathTranslate/releases)
2. Unzip and double-click `pdf2zh.exe` to run.
</details>
<details>
<summary>3. Graphic user interface</summary>
1. Python installed (3.10 <= version <= 3.12)
2. Install our package:
```bash
pip install pdf2zh
```
3. Start using in browser:
```bash
pdf2zh -i
```
4. If your browser has not been started automatically, goto
```bash
http://localhost:7860/
```
<img src="./docs/images/gui.gif" width="500"/>
See [documentation for GUI](./docs/README_GUI.md) for more details.
</details>
<details>
<summary>4. Docker</summary>
1. Pull and run:
```bash
docker pull byaidu/pdf2zh
docker run -d -p 7860:7860 byaidu/pdf2zh
```
2. Open in browser:
```
http://localhost:7860/
```
For docker deployment on cloud service:
<div>
<a href="https://www.heroku.com/deploy?template=https://github.com/Byaidu/PDFMathTranslate">
<img src="https://www.herokucdn.com/deploy/button.svg" alt="Deploy" height="26"></a>
<a href="https://render.com/deploy">
<img src="https://render.com/images/deploy-to-render-button.svg" alt="Deploy to Koyeb" height="26"></a>
<a href="https://zeabur.com/templates/5FQIGX?referralCode=reycn">
<img src="https://zeabur.com/button.svg" alt="Deploy on Zeabur" height="26"></a>
<a href="https://template.sealos.io/deploy?templateName=pdf2zh">
<img src="https://sealos.io/Deploy-on-Sealos.svg" alt="Deploy on Sealos" height="26"></a>
<a href="https://app.koyeb.com/deploy?type=git&builder=buildpack&repository=github.com/Byaidu/PDFMathTranslate&branch=main&name=pdf-math-translate">
<img src="https://www.koyeb.com/static/images/deploy/button.svg" alt="Deploy to Koyeb" height="26"></a>
</div>
</details>
<details>
<summary>5. Zotero Plugin</summary>
See [Zotero PDF2zh](https://github.com/guaguastandup/zotero-pdf2zh) for more details.
</details>
<details>
<summary>6. Commandline</summary>
1. Python installed (3.10 <= version <= 3.12)
2. Install our package:
```bash
pip install pdf2zh
```
3. Execute translation, files generated in [current working directory](https://chatgpt.com/share/6745ed36-9acc-800e-8a90-59204bd13444):
```bash
pdf2zh document.pdf
```
</details>
> [!TIP]
>
> - If you're using Windows and cannot open the file after downloading, please install [vc_redist.x64.exe](https://aka.ms/vs/17/release/vc_redist.x64.exe) and try again.
>
> - If you cannot access Docker Hub, please try the image on [GitHub Container Registry](https://github.com/Byaidu/PDFMathTranslate/pkgs/container/pdfmathtranslate).
> ```bash
> docker pull ghcr.io/byaidu/pdfmathtranslate
> docker run -d -p 7860:7860 ghcr.io/byaidu/pdfmathtranslate
> ```
### Unable to install?
The present program needs an AI model(`wybxc/DocLayout-YOLO-DocStructBench-onnx`) before working and some users are not able to download due to network issues. If you have a problem with downloading this model, we provide a workaround using the following environment variable:
```shell
set HF_ENDPOINT=https://hf-mirror.com
```
For PowerShell user:
```shell
$env:HF_ENDPOINT = https://hf-mirror.com
```
If the solution does not work to you / you encountered other issues, please refer to [frequently asked questions](https://github.com/Byaidu/PDFMathTranslate/wiki#-faq--%E5%B8%B8%E8%A7%81%E9%97%AE%E9%A2%98).
<h2 id="usage">Advanced Options</h2>
Execute the translation command in the command line to generate the translated document `example-mono.pdf` and the bilingual document `example-dual.pdf` in the current working directory. Use Google as the default translation service. More support translation services can find [HERE](https://github.com/Byaidu/PDFMathTranslate/blob/main/docs/ADVANCED.md#services).
<img src="./docs/images/cmd.explained.png" width="580px" alt="cmd"/>
In the following table, we list all advanced options for reference:
| Option | Function | Example |
| --------------------- | ------------------------------------------------------------------------------------------------------------- | ---------------------------------------------- |
| files | Local files | `pdf2zh ~/local.pdf` |
| links | Online files | `pdf2zh http://arxiv.org/paper.pdf` |
| `-i` | [Enter GUI](#gui) | `pdf2zh -i` |
| `-p` | [Partial document translation](https://github.com/Byaidu/PDFMathTranslate/blob/main/docs/ADVANCED.md#partial) | `pdf2zh example.pdf -p 1` |
| `-li` | [Source language](https://github.com/Byaidu/PDFMathTranslate/blob/main/docs/ADVANCED.md#languages) | `pdf2zh example.pdf -li en` |
| `-lo` | [Target language](https://github.com/Byaidu/PDFMathTranslate/blob/main/docs/ADVANCED.md#languages) | `pdf2zh example.pdf -lo zh` |
| `-s` | [Translation service](https://github.com/Byaidu/PDFMathTranslate/blob/main/docs/ADVANCED.md#services) | `pdf2zh example.pdf -s deepl` |
| `-t` | [Multi-threads](https://github.com/Byaidu/PDFMathTranslate/blob/main/docs/ADVANCED.md#threads) | `pdf2zh example.pdf -t 1` |
| `-o` | Output dir | `pdf2zh example.pdf -o output` |
| `-f`, `-c` | [Exceptions](https://github.com/Byaidu/PDFMathTranslate/blob/main/docs/ADVANCED.md#exceptions) | `pdf2zh example.pdf -f "(MS.*)"` |
| `-cp` | Compatibility Mode | `pdf2zh example.pdf --compatible` |
| `--skip-subset-fonts` | [Skip font subset](https://github.com/Byaidu/PDFMathTranslate/blob/main/docs/ADVANCED.md#font-subset) | `pdf2zh example.pdf --skip-subset-fonts` |
| `--ignore-cache` | [Ignore translate cache](https://github.com/Byaidu/PDFMathTranslate/blob/main/docs/ADVANCED.md#cache) | `pdf2zh example.pdf --ignore-cache` |
| `--share` | Public link | `pdf2zh -i --share` |
| `--authorized` | [Authorization](https://github.com/Byaidu/PDFMathTranslate/blob/main/docs/ADVANCED.md#auth) | `pdf2zh -i --authorized users.txt [auth.html]` |
| `--prompt` | [Custom Prompt](https://github.com/Byaidu/PDFMathTranslate/blob/main/docs/ADVANCED.md#prompt) | `pdf2zh --prompt [prompt.txt]` |
| `--onnx` | [Use Custom DocLayout-YOLO ONNX model] | `pdf2zh --onnx [onnx/model/path]` |
| `--serverport` | [Use Custom WebUI port] | `pdf2zh --serverport 7860` |
| `--dir` | [batch translate] | `pdf2zh --dir /path/to/translate/` |
| `--config` | [configuration file](https://github.com/Byaidu/PDFMathTranslate/blob/main/docs/ADVANCED.md#cofig) | `pdf2zh --config /path/to/config/config.json` |
| `--serverport` | [custom gradio server port] | `pdf2zh --serverport 7860` |
| `--babeldoc` | Use Experimental backend [BabelDOC](https://funstory-ai.github.io/BabelDOC/) to translate | `pdf2zh --babeldoc` -s openai example.pdf |
| `--mcp` | Enable MCP STDIO mode | `pdf2zh --mcp` |
| `--sse` | Enable MCP SSE mode | `pdf2zh --mcp --sse` |
For detailed explanations, please refer to our document about [Advanced Usage](./docs/ADVANCED.md) for a full list of each option.
<h2 id="downstream">Secondary Development (APIs)</h2>
For downstream applications, please refer to our document about [API Details](./docs/APIS.md) for further information about:
- [Python API](./docs/APIS.md#api-python), how to use the program in other Python programs
- [HTTP API](./docs/APIS.md#api-http), how to communicate with a server with the program installed
<h2 id="todo">TODOs</h2>
- [ ] Parse layout with DocLayNet based models, [PaddleX](https://github.com/PaddlePaddle/PaddleX/blob/17cc27ac3842e7880ca4aad92358d3ef8555429a/paddlex/repo_apis/PaddleDetection_api/object_det/official_categories.py#L81), [PaperMage](https://github.com/allenai/papermage/blob/9cd4bb48cbedab45d0f7a455711438f1632abebe/README.md?plain=1#L102), [SAM2](https://github.com/facebookresearch/sam2)
- [ ] Fix page rotation, table of contents, format of lists
- [ ] Fix pixel formula in old papers
- [ ] Async retry except KeyboardInterrupt
- [ ] Knuth–Plass algorithm for western languages
- [ ] Support non-PDF/A files
- [ ] Plugins of [Zotero](https://github.com/zotero/zotero) and [Obsidian](https://github.com/obsidianmd/obsidian-releases)
<h2 id="acknowledgement">Acknowledgements</h2>
- [Immersive Translation](https://immersivetranslate.com) sponsors monthly Pro membership redemption codes for active contributors to this project, see details at: [CONTRIBUTOR_REWARD.md](https://github.com/funstory-ai/BabelDOC/blob/main/docs/CONTRIBUTOR_REWARD.md)
- New backend: [BabelDOC](https://github.com/funstory-ai/BabelDOC)
- Document merging: [PyMuPDF](https://github.com/pymupdf/PyMuPDF)
- Document parsing: [Pdfminer.six](https://github.com/pdfminer/pdfminer.six)
- Document extraction: [MinerU](https://github.com/opendatalab/MinerU)
- Document Preview: [Gradio PDF](https://github.com/freddyaboulton/gradio-pdf)
- Multi-threaded translation: [MathTranslate](https://github.com/SUSYUSTC/MathTranslate)
- Layout parsing: [DocLayout-YOLO](https://github.com/opendatalab/DocLayout-YOLO)
- Document standard: [PDF Explained](https://zxyle.github.io/PDF-Explained/), [PDF Cheat Sheets](https://pdfa.org/resource/pdf-cheat-sheets/)
- Multilingual Font: [Go Noto Universal](https://github.com/satbyy/go-noto-universal)
<h2 id="contrib">Contributors</h2>
<a href="https://github.com/Byaidu/PDFMathTranslate/graphs/contributors">
<img src="https://opencollective.com/PDFMathTranslate/contributors.svg?width=890&button=false" />
</a>
<h2 id="star_hist">Star History</h2>
<a href="https://star-history.com/#Byaidu/PDFMathTranslate&Date">
<picture>
<source media="(prefers-color-scheme: dark)" srcset="https://api.star-history.com/svg?repos=Byaidu/PDFMathTranslate&type=Date&theme=dark" />
<source media="(prefers-color-scheme: light)" srcset="https://api.star-history.com/svg?repos=Byaidu/PDFMathTranslate&type=Date" />
<img alt="Star History Chart" src="https://api.star-history.com/svg?repos=Byaidu/PDFMathTranslate&type=Date"/>
</picture>
</a>
Raw data
{
"_id": null,
"home_page": null,
"name": "pdf2zh",
"maintainer": null,
"docs_url": null,
"requires_python": "<3.13,>=3.10",
"maintainer_email": null,
"keywords": null,
"author": null,
"author_email": "Byaidu <byaidux@gmail.com>",
"download_url": "https://files.pythonhosted.org/packages/49/59/a720f6c1e11594a226b4cb6fafced174b75e2f28694e5f4b669569b975e0/pdf2zh-1.9.11.tar.gz",
"platform": null,
"description": "<div align=\"center\">\n\nEnglish | [\u7b80\u4f53\u4e2d\u6587](docs/README_zh-CN.md) | [\u7e41\u9ad4\u4e2d\u6587](docs/README_zh-TW.md) | [\u65e5\u672c\u8a9e](docs/README_ja-JP.md) | [\ud55c\uad6d\uc5b4](docs/README_ko-KR.md)\n\n<img src=\"./docs/images/banner.png\" width=\"320px\" alt=\"PDF2ZH\"/>\n\n<h2 id=\"title\">PDFMathTranslate</h2>\n\n<p>\n <!-- PyPI -->\n <a href=\"https://pypi.org/project/pdf2zh/\">\n <img src=\"https://img.shields.io/pypi/v/pdf2zh\"></a>\n <a href=\"https://pepy.tech/projects/pdf2zh\">\n <img src=\"https://static.pepy.tech/badge/pdf2zh\"></a>\n <a href=\"https://hub.docker.com/repository/docker/byaidu/pdf2zh\">\n <img src=\"https://img.shields.io/docker/pulls/byaidu/pdf2zh\"></a>\n <a href=\"https://hellogithub.com/repository/8ec2cfd3ef744762bf531232fa32bc47\" target=\"_blank\"><img src=\"https://api.hellogithub.com/v1/widgets/recommend.svg?rid=8ec2cfd3ef744762bf531232fa32bc47&claim_uid=JQ0yfeBNjaTuqDU&theme=small\" alt=\"Featured\uff5cHelloGitHub\" /></a>\n <a href=\"https://gitcode.com/Byaidu/PDFMathTranslate/overview\">\n <img src=\"https://gitcode.com/Byaidu/PDFMathTranslate/star/badge.svg\"></a>\n <a href=\"https://huggingface.co/spaces/reycn/PDFMathTranslate-Docker\">\n <img src=\"https://img.shields.io/badge/%F0%9F%A4%97-Online%20Demo-FF9E0D\"></a>\n <a href=\"https://www.modelscope.cn/studios/AI-ModelScope/PDFMathTranslate\">\n <img src=\"https://img.shields.io/badge/ModelScope-Demo-blue\"></a>\n <a href=\"https://github.com/Byaidu/PDFMathTranslate/pulls\">\n <img src=\"https://img.shields.io/badge/contributions-welcome-green\"></a>\n <a href=\"https://t.me/+Z9_SgnxmsmA5NzBl\">\n <img src=\"https://img.shields.io/badge/Telegram-2CA5E0?style=flat-squeare&logo=telegram&logoColor=white\"></a>\n <!-- License -->\n <a href=\"./LICENSE\">\n <img src=\"https://img.shields.io/github/license/Byaidu/PDFMathTranslate\"></a>\n</p>\n\n<a href=\"https://trendshift.io/repositories/12424\" target=\"_blank\"><img src=\"https://trendshift.io/api/badge/repositories/12424\" alt=\"Byaidu%2FPDFMathTranslate | Trendshift\" style=\"width: 250px; height: 55px;\" width=\"250\" height=\"55\"/></a>\n\n</div>\n\nPDF scientific paper translation and bilingual comparison.\n\n- \ud83d\udcca Preserve formulas, charts, table of contents, and annotations _([preview](#preview))_.\n- \ud83c\udf10 Support [multiple languages](#language), and diverse [translation services](#services).\n- \ud83e\udd16 Provides [commandline tool](#usage), [interactive user interface](#gui), and [Docker](#docker)\n\nFeel free to provide feedback in [GitHub Issues](https://github.com/Byaidu/PDFMathTranslate/issues) or [Telegram Group](https://t.me/+Z9_SgnxmsmA5NzBl).\n\nFor details on how to contribute, please consult the [Contribution Guide](https://github.com/Byaidu/PDFMathTranslate/wiki/Contribution-Guide---%E8%B4%A1%E7%8C%AE%E6%8C%87%E5%8D%97).\n\n<h2 id=\"updates\">Updates</h2>\n\n- [May 9, 2025] pdf2zh 2.0 Preview Version [#586](https://github.com/Byaidu/PDFMathTranslate/issues/586): The Windows ZIP file and Docker image are now available.\n\n> [!NOTE]\n>\n> 2.0 Moved to a new repository under the organization: [PDFMathTranslate/PDFMathTranslate-next](https://github.com/PDFMathTranslate/PDFMathTranslate-next)\n> \n> Version 2.0 official release has been published.\n\n- [Mar. 3, 2025] Experimental support for the new backend [BabelDOC](https://github.com/funstory-ai/BabelDOC) WebUI added as an experimental option (by [@awwaawwa](https://github.com/awwaawwa))\n- [Feb. 22 2025] Better release CI and well-packaged windows-amd64 exe (by [@awwaawwa](https://github.com/awwaawwa))\n- [Dec. 24 2024] The translator now supports local models on [Xinference](https://github.com/xorbitsai/inference) _(by [@imClumsyPanda](https://github.com/imClumsyPanda))_\n- [Dec. 19 2024] Non-PDF/A documents are now supported using `-cp` _(by [@reycn](https://github.com/reycn))_\n- [Dec. 13 2024] Additional support for backend by _(by [@YadominJinta](https://github.com/YadominJinta))_\n- [Dec. 10 2024] The translator now supports OpenAI models on Azure _(by [@yidasanqian](https://github.com/yidasanqian))_\n\n<h2 id=\"preview\">Preview</h2>\n\n<div align=\"center\">\n<img src=\"./docs/images/preview.gif\" width=\"80%\"/>\n</div>\n\n<h2 id=\"demo\">Online Service \ud83c\udf1f</h2>\n\nYou can try our application out using either of the following demos:\n\n- [Public free service](https://pdf2zh.com/) online without installation _(recommended)_.\n- [Immersive Translate - BabelDOC](https://app.immersivetranslate.com/babel-doc/) 1000 free pages per month. _(recommended)_\n- [Demo hosted on HuggingFace](https://huggingface.co/spaces/reycn/PDFMathTranslate-Docker)\n- [Demo hosted on ModelScope](https://www.modelscope.cn/studios/AI-ModelScope/PDFMathTranslate) without installation.\n\nNote that the computing resources of the demo are limited, so please avoid abusing them.\n\n<h2 id=\"install\">Installation and Usage</h2>\n\n### Methods\n\nFor different use cases, we provide distinct methods to use our program:\n\n<details open>\n <summary>1. UV install</summary>\n\n1. Python installed (3.10 <= version <= 3.12)\n\n2. Install our package:\n\n ```bash\n pip install uv\n uv tool install --python 3.12 pdf2zh\n ```\n\n3. Execute translation, files generated in [current working directory](https://chatgpt.com/share/6745ed36-9acc-800e-8a90-59204bd13444):\n\n ```bash\n pdf2zh document.pdf\n ```\n\n</details>\n\n<details>\n <summary>2. Windows exe</summary>\n\n1. Download pdf2zh-version-win64.zip from [release page](https://github.com/Byaidu/PDFMathTranslate/releases)\n\n2. Unzip and double-click `pdf2zh.exe` to run.\n\n</details>\n\n<details>\n <summary>3. Graphic user interface</summary>\n\n1. Python installed (3.10 <= version <= 3.12)\n\n2. Install our package:\n\n```bash\npip install pdf2zh\n```\n\n3. Start using in browser:\n\n ```bash\n pdf2zh -i\n ```\n\n4. If your browser has not been started automatically, goto\n\n ```bash\n http://localhost:7860/\n ```\n\n <img src=\"./docs/images/gui.gif\" width=\"500\"/>\n\nSee [documentation for GUI](./docs/README_GUI.md) for more details.\n\n</details>\n\n<details>\n <summary>4. Docker</summary>\n\n1. Pull and run:\n\n ```bash\n docker pull byaidu/pdf2zh\n docker run -d -p 7860:7860 byaidu/pdf2zh\n ```\n\n2. Open in browser:\n\n ```\n http://localhost:7860/\n ```\n\nFor docker deployment on cloud service:\n\n<div>\n<a href=\"https://www.heroku.com/deploy?template=https://github.com/Byaidu/PDFMathTranslate\">\n <img src=\"https://www.herokucdn.com/deploy/button.svg\" alt=\"Deploy\" height=\"26\"></a>\n<a href=\"https://render.com/deploy\">\n <img src=\"https://render.com/images/deploy-to-render-button.svg\" alt=\"Deploy to Koyeb\" height=\"26\"></a>\n<a href=\"https://zeabur.com/templates/5FQIGX?referralCode=reycn\">\n <img src=\"https://zeabur.com/button.svg\" alt=\"Deploy on Zeabur\" height=\"26\"></a>\n<a href=\"https://template.sealos.io/deploy?templateName=pdf2zh\">\n <img src=\"https://sealos.io/Deploy-on-Sealos.svg\" alt=\"Deploy on Sealos\" height=\"26\"></a>\n<a href=\"https://app.koyeb.com/deploy?type=git&builder=buildpack&repository=github.com/Byaidu/PDFMathTranslate&branch=main&name=pdf-math-translate\">\n <img src=\"https://www.koyeb.com/static/images/deploy/button.svg\" alt=\"Deploy to Koyeb\" height=\"26\"></a>\n</div>\n\n</details>\n\n<details>\n <summary>5. Zotero Plugin</summary>\n\n\nSee [Zotero PDF2zh](https://github.com/guaguastandup/zotero-pdf2zh) for more details.\n\n</details>\n\n<details>\n <summary>6. Commandline</summary>\n\n1. Python installed (3.10 <= version <= 3.12)\n2. Install our package:\n\n ```bash\n pip install pdf2zh\n ```\n\n3. Execute translation, files generated in [current working directory](https://chatgpt.com/share/6745ed36-9acc-800e-8a90-59204bd13444):\n\n ```bash\n pdf2zh document.pdf\n ```\n\n</details>\n\n> [!TIP]\n>\n> - If you're using Windows and cannot open the file after downloading, please install [vc_redist.x64.exe](https://aka.ms/vs/17/release/vc_redist.x64.exe) and try again.\n>\n> - If you cannot access Docker Hub, please try the image on [GitHub Container Registry](https://github.com/Byaidu/PDFMathTranslate/pkgs/container/pdfmathtranslate).\n> ```bash\n> docker pull ghcr.io/byaidu/pdfmathtranslate\n> docker run -d -p 7860:7860 ghcr.io/byaidu/pdfmathtranslate\n> ```\n\n### Unable to install?\n\nThe present program needs an AI model(`wybxc/DocLayout-YOLO-DocStructBench-onnx`) before working and some users are not able to download due to network issues. If you have a problem with downloading this model, we provide a workaround using the following environment variable:\n\n```shell\nset HF_ENDPOINT=https://hf-mirror.com\n```\n\nFor PowerShell user:\n\n```shell\n$env:HF_ENDPOINT = https://hf-mirror.com\n```\n\nIf the solution does not work to you / you encountered other issues, please refer to [frequently asked questions](https://github.com/Byaidu/PDFMathTranslate/wiki#-faq--%E5%B8%B8%E8%A7%81%E9%97%AE%E9%A2%98).\n\n<h2 id=\"usage\">Advanced Options</h2>\n\nExecute the translation command in the command line to generate the translated document `example-mono.pdf` and the bilingual document `example-dual.pdf` in the current working directory. Use Google as the default translation service. More support translation services can find [HERE](https://github.com/Byaidu/PDFMathTranslate/blob/main/docs/ADVANCED.md#services).\n\n<img src=\"./docs/images/cmd.explained.png\" width=\"580px\" alt=\"cmd\"/>\n\nIn the following table, we list all advanced options for reference:\n\n| Option | Function | Example |\n| --------------------- | ------------------------------------------------------------------------------------------------------------- | ---------------------------------------------- |\n| files | Local files | `pdf2zh ~/local.pdf` |\n| links | Online files | `pdf2zh http://arxiv.org/paper.pdf` |\n| `-i` | [Enter GUI](#gui) | `pdf2zh -i` |\n| `-p` | [Partial document translation](https://github.com/Byaidu/PDFMathTranslate/blob/main/docs/ADVANCED.md#partial) | `pdf2zh example.pdf -p 1` |\n| `-li` | [Source language](https://github.com/Byaidu/PDFMathTranslate/blob/main/docs/ADVANCED.md#languages) | `pdf2zh example.pdf -li en` |\n| `-lo` | [Target language](https://github.com/Byaidu/PDFMathTranslate/blob/main/docs/ADVANCED.md#languages) | `pdf2zh example.pdf -lo zh` |\n| `-s` | [Translation service](https://github.com/Byaidu/PDFMathTranslate/blob/main/docs/ADVANCED.md#services) | `pdf2zh example.pdf -s deepl` |\n| `-t` | [Multi-threads](https://github.com/Byaidu/PDFMathTranslate/blob/main/docs/ADVANCED.md#threads) | `pdf2zh example.pdf -t 1` |\n| `-o` | Output dir | `pdf2zh example.pdf -o output` |\n| `-f`, `-c` | [Exceptions](https://github.com/Byaidu/PDFMathTranslate/blob/main/docs/ADVANCED.md#exceptions) | `pdf2zh example.pdf -f \"(MS.*)\"` |\n| `-cp` | Compatibility Mode | `pdf2zh example.pdf --compatible` |\n| `--skip-subset-fonts` | [Skip font subset](https://github.com/Byaidu/PDFMathTranslate/blob/main/docs/ADVANCED.md#font-subset) | `pdf2zh example.pdf --skip-subset-fonts` |\n| `--ignore-cache` | [Ignore translate cache](https://github.com/Byaidu/PDFMathTranslate/blob/main/docs/ADVANCED.md#cache) | `pdf2zh example.pdf --ignore-cache` |\n| `--share` | Public link | `pdf2zh -i --share` |\n| `--authorized` | [Authorization](https://github.com/Byaidu/PDFMathTranslate/blob/main/docs/ADVANCED.md#auth) | `pdf2zh -i --authorized users.txt [auth.html]` |\n| `--prompt` | [Custom Prompt](https://github.com/Byaidu/PDFMathTranslate/blob/main/docs/ADVANCED.md#prompt) | `pdf2zh --prompt [prompt.txt]` |\n| `--onnx` | [Use Custom DocLayout-YOLO ONNX model] | `pdf2zh --onnx [onnx/model/path]` |\n| `--serverport` | [Use Custom WebUI port] | `pdf2zh --serverport 7860` |\n| `--dir` | [batch translate] | `pdf2zh --dir /path/to/translate/` |\n| `--config` | [configuration file](https://github.com/Byaidu/PDFMathTranslate/blob/main/docs/ADVANCED.md#cofig) | `pdf2zh --config /path/to/config/config.json` |\n| `--serverport` | [custom gradio server port] | `pdf2zh --serverport 7860` |\n| `--babeldoc` | Use Experimental backend [BabelDOC](https://funstory-ai.github.io/BabelDOC/) to translate | `pdf2zh --babeldoc` -s openai example.pdf |\n| `--mcp` | Enable MCP STDIO mode | `pdf2zh --mcp` |\n| `--sse` | Enable MCP SSE mode | `pdf2zh --mcp --sse` |\n\nFor detailed explanations, please refer to our document about [Advanced Usage](./docs/ADVANCED.md) for a full list of each option.\n\n<h2 id=\"downstream\">Secondary Development (APIs)</h2>\n\nFor downstream applications, please refer to our document about [API Details](./docs/APIS.md) for further information about:\n\n- [Python API](./docs/APIS.md#api-python), how to use the program in other Python programs\n- [HTTP API](./docs/APIS.md#api-http), how to communicate with a server with the program installed\n\n<h2 id=\"todo\">TODOs</h2>\n\n- [ ] Parse layout with DocLayNet based models, [PaddleX](https://github.com/PaddlePaddle/PaddleX/blob/17cc27ac3842e7880ca4aad92358d3ef8555429a/paddlex/repo_apis/PaddleDetection_api/object_det/official_categories.py#L81), [PaperMage](https://github.com/allenai/papermage/blob/9cd4bb48cbedab45d0f7a455711438f1632abebe/README.md?plain=1#L102), [SAM2](https://github.com/facebookresearch/sam2)\n\n- [ ] Fix page rotation, table of contents, format of lists\n\n- [ ] Fix pixel formula in old papers\n\n- [ ] Async retry except KeyboardInterrupt\n\n- [ ] Knuth\u2013Plass algorithm for western languages\n\n- [ ] Support non-PDF/A files\n\n- [ ] Plugins of [Zotero](https://github.com/zotero/zotero) and [Obsidian](https://github.com/obsidianmd/obsidian-releases)\n\n<h2 id=\"acknowledgement\">Acknowledgements</h2>\n\n- [Immersive Translation](https://immersivetranslate.com) sponsors monthly Pro membership redemption codes for active contributors to this project, see details at: [CONTRIBUTOR_REWARD.md](https://github.com/funstory-ai/BabelDOC/blob/main/docs/CONTRIBUTOR_REWARD.md)\n\n- New backend: [BabelDOC](https://github.com/funstory-ai/BabelDOC)\n\n- Document merging: [PyMuPDF](https://github.com/pymupdf/PyMuPDF)\n\n- Document parsing: [Pdfminer.six](https://github.com/pdfminer/pdfminer.six)\n\n- Document extraction: [MinerU](https://github.com/opendatalab/MinerU)\n\n- Document Preview: [Gradio PDF](https://github.com/freddyaboulton/gradio-pdf)\n\n- Multi-threaded translation: [MathTranslate](https://github.com/SUSYUSTC/MathTranslate)\n\n- Layout parsing: [DocLayout-YOLO](https://github.com/opendatalab/DocLayout-YOLO)\n\n- Document standard: [PDF Explained](https://zxyle.github.io/PDF-Explained/), [PDF Cheat Sheets](https://pdfa.org/resource/pdf-cheat-sheets/)\n\n- Multilingual Font: [Go Noto Universal](https://github.com/satbyy/go-noto-universal)\n\n<h2 id=\"contrib\">Contributors</h2>\n\n<a href=\"https://github.com/Byaidu/PDFMathTranslate/graphs/contributors\">\n <img src=\"https://opencollective.com/PDFMathTranslate/contributors.svg?width=890&button=false\" />\n</a>\n\n![Alt](https://repobeats.axiom.co/api/embed/dfa7583da5332a11468d686fbd29b92320a6a869.svg \"Repobeats analytics image\")\n\n<h2 id=\"star_hist\">Star History</h2>\n\n<a href=\"https://star-history.com/#Byaidu/PDFMathTranslate&Date\">\n <picture>\n <source media=\"(prefers-color-scheme: dark)\" srcset=\"https://api.star-history.com/svg?repos=Byaidu/PDFMathTranslate&type=Date&theme=dark\" />\n <source media=\"(prefers-color-scheme: light)\" srcset=\"https://api.star-history.com/svg?repos=Byaidu/PDFMathTranslate&type=Date\" />\n <img alt=\"Star History Chart\" src=\"https://api.star-history.com/svg?repos=Byaidu/PDFMathTranslate&type=Date\"/>\n </picture>\n</a>\n",
"bugtrack_url": null,
"license": null,
"summary": "Latex PDF Translator",
"version": "1.9.11",
"project_urls": {
"Homepage": "https://github.com/Byaidu/PDFMathTranslate"
},
"split_keywords": [],
"urls": [
{
"comment_text": null,
"digests": {
"blake2b_256": "71c6a06f737a974fe3d0a676dac83e3506465843441a2ed8cc6cb698993c5818",
"md5": "9a4a2a5aa1280e531b470a686345f046",
"sha256": "bd07509730bf87beec158f7c1efac9e96af0aa6657e6f1cf6ff359225609ad4d"
},
"downloads": -1,
"filename": "pdf2zh-1.9.11-py3-none-any.whl",
"has_sig": false,
"md5_digest": "9a4a2a5aa1280e531b470a686345f046",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": "<3.13,>=3.10",
"size": 62330,
"upload_time": "2025-07-11T08:35:44",
"upload_time_iso_8601": "2025-07-11T08:35:44.383597Z",
"url": "https://files.pythonhosted.org/packages/71/c6/a06f737a974fe3d0a676dac83e3506465843441a2ed8cc6cb698993c5818/pdf2zh-1.9.11-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": null,
"digests": {
"blake2b_256": "4959a720f6c1e11594a226b4cb6fafced174b75e2f28694e5f4b669569b975e0",
"md5": "ca25f1e2689ddb2909f7b12930fe934c",
"sha256": "8135d3d0b76d2416437b2245285dfe6acf576723e5219889b4a4960b267f4cb4"
},
"downloads": -1,
"filename": "pdf2zh-1.9.11.tar.gz",
"has_sig": false,
"md5_digest": "ca25f1e2689ddb2909f7b12930fe934c",
"packagetype": "sdist",
"python_version": "source",
"requires_python": "<3.13,>=3.10",
"size": 4142339,
"upload_time": "2025-07-11T08:35:46",
"upload_time_iso_8601": "2025-07-11T08:35:46.467945Z",
"url": "https://files.pythonhosted.org/packages/49/59/a720f6c1e11594a226b4cb6fafced174b75e2f28694e5f4b669569b975e0/pdf2zh-1.9.11.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2025-07-11 08:35:46",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "Byaidu",
"github_project": "PDFMathTranslate",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "pdf2zh"
}
