| Name | pdf2zh JSON |
| Version |
1.8.8
JSON |
| download |
| home_page | None |
| Summary | Latex PDF Translator |
| upload_time | 2024-12-15 14:30:49 |
| maintainer | None |
| docs_url | None |
| author | None |
| requires_python | <3.13,>=3.9 |
| license | AGPL-3.0 |
| keywords |
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
<div align="center">
English | [简体中文](README_zh-CN.md) | [日本語](README_ja-JP.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>
<!-- License -->
<a href="./LICENSE">
<img src="https://img.shields.io/github/license/Byaidu/PDFMathTranslate"></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://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>
</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), [Telegram Group](https://t.me/+Z9_SgnxmsmA5NzBl) or [QQ Group](https://qm.qq.com/q/DixZCxQej0).
<h2 id="updates">Updates</h2>
- [Nov. 26 2024] CLI now supports online file(s) *(by [@reycn](https://github.com/reycn))*
- [Nov. 24 2024] [ONNX](https://github.com/onnx/onnx) support to reduce dependency sizes *(by [@Wybxc](https://github.com/Wybxc))*
- [Nov. 23 2024] 🌟 [Public Service](#demo) online! *(by [@Byaidu](https://github.com/Byaidu))*
- [Nov. 23 2024] Firewall for preventing web bots *(by [@Byaidu](https://github.com/Byaidu))*
- [Nov. 22 2024] GUI now supports Italian, and has been improved *(by [@Byaidu](https://github.com/Byaidu), [@reycn](https://github.com/reycn))*
- [Nov. 22 2024] You can now share your deployed service to others *(by [@Zxis233](https://github.com/Zxis233))*
- [Nov. 22 2024] Now supports Tencent Translation *(by [@hellofinch](https://github.com/hellofinch))*
- [Nov. 21 2024] GUI now supports downloading dual-document *(by [@reycn](https://github.com/reycn))*
- [Nov. 20 2024] 🌟 [Demo](#demo) online! *(by [@reycn](https://github.com/reycn))*
<h2 id="preview">Preview</h2>
<div align="center">
<img src="./docs/images/preview.gif" width="80%"/>
</div>
<h2 id="demo">Public Service 🌟</h2>
### Free Service (<https://pdf2zh.com/>)
You can try our [public service](https://pdf2zh.com/) online without installation.
### Hugging Face Demo
You can try [our demo on HuggingFace](https://huggingface.co/spaces/reycn/PDFMathTranslate-Docker) without installation.
Note that the computing resources of the demo are limited, so please avoid abusing them.
<h2 id="install">Installation and Usage</h2>
We provide four methods for using this project: [Commandline](#cmd), [Portable](#portable), [GUI](#gui), and [Docker](#docker).
<h3 id="cmd">Method I. Commandline</h3>
1. Python installed (3.8 <= 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
```
<h3 id="portable">Method II. Portable</h3>
No need to pre-install Python environment
Download [setup.bat](https://raw.githubusercontent.com/Byaidu/PDFMathTranslate/refs/heads/main/setup.bat) and double-click to run
<h3 id="gui">Method III. GUI</h3>
1. Python installed (3.8 <= version <= 3.12)
2. Install our package:
```bash
pip install pdf2zh
```
3. Start using in browser:
```bash
pdf2zh -i
```
4. If your browswer 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.
<h3 id="docker">Method IV. Docker</h3>
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://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>
<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.
<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](#partial) | `pdf2zh example.pdf -p 1` |
| `-li` | [Source language](#languages) | `pdf2zh example.pdf -li en` |
| `-lo` | [Target language](#languages) | `pdf2zh example.pdf -lo zh` |
| `-s` | [Translation service](#services) | `pdf2zh example.pdf -s deepl` |
| `-t` | [Multi-threads](#threads) | `pdf2zh example.pdf -t 1` |
| `-o` | Output dir | `pdf2zh example.pdf -o output` |
| `-f`, `-c` | [Exceptions](#exceptions) | `pdf2zh example.pdf -f "(MS.*)"` |
| `--share` | Get gradio public link | `pdf2zh -i --share` |
<h3 id="partial">Full / partial document translation</h3>
- Entire document
```bash
pdf2zh example.pdf
```
- Part of the document
```bash
pdf2zh example.pdf -p 1-3,5
```
<h3 id="language">Specify source and target languages</h3>
See [Google Languages Codes](https://developers.google.com/admin-sdk/directory/v1/languages), [DeepL Languages Codes](https://developers.deepl.com/docs/resources/supported-languages)
```bash
pdf2zh example.pdf -li en -lo ja
```
<h3 id="services">Translate with Different Services</h3>
The table below outlines the required [environment variables](https://chatgpt.com/share/6734a83d-9d48-800e-8a46-f57ca6e8bcb4) for each translation service. Make sure to set them before using the respective service.
|**Translator**|**Service**|**Environment Variables**|**Default Values**|**Notes**|
|-|-|-|-|-|
|**Google (Default)**|`google`|None|N/A|None|
|**Bing**|`bing`|None|N/A|None|
|**DeepL**|`deepl`|`DEEPL_SERVER_URL`,`DEEPL_AUTH_KEY`|`https://api.deepl.com`, `[Your Key]`|See [DeepL](https://support.deepl.com/hc/en-us/articles/360020695820-API-Key-for-DeepL-s-API)|
|**DeepLX**|`deeplx`|`DEEPLX_ENDPOINT`|`https://api.deepl.com/translate`|See [DeepLX](https://github.com/OwO-Network/DeepLX)|
|**Ollama**|`ollama`|`OLLAMA_HOST`, `OLLAMA_MODEL`|`http://127.0.0.1:11434`, `gemma2`|See [Ollama](https://github.com/ollama/ollama)|
|**OpenAI**|`openai`|`OPENAI_BASE_URL`, `OPENAI_API_KEY`, `OPENAI_MODEL`|`https://api.openai.com/v1`, `[Your Key]`, `gpt-4o-mini`|See [OpenAI](https://platform.openai.com/docs/overview)|
|**AzureOpenAI**|`azure-openai`|`AZURE_OPENAI_BASE_URL`, `AZURE_OPENAI_API_KEY`, `AZURE_OPENAI_MODEL`|`[Your Endpoint]`, `[Your Key]`, `gpt-4o-mini`|See [Azure OpenAI](https://learn.microsoft.com/zh-cn/azure/ai-services/openai/chatgpt-quickstart?tabs=command-line%2Cjavascript-keyless%2Ctypescript-keyless%2Cpython&pivots=programming-language-python)|
|**Zhipu**|`zhipu`|`ZHIPU_API_KEY`, `ZHIPU_MODEL`|`[Your Key]`, `glm-4-flash`|See [Zhipu](https://open.bigmodel.cn/dev/api/thirdparty-frame/openai-sdk)|
|**Silicon**|`silicon`|`SILICON_API_KEY`, `SILICON_MODEL`|`[Your Key]`, `Qwen/Qwen2.5-7B-Instruct`|See [SiliconCloud](https://docs.siliconflow.cn/quickstart)|
|**Gemini**|`gemini`|`GEMINI_API_KEY`, `GEMINI_MODEL`|`[Your Key]`, `gemini-1.5-flash`|See [Gemini](https://ai.google.dev/gemini-api/docs/openai)|
|**Azure**|`azure`|`AZURE_ENDPOINT`, `AZURE_API_KEY`|`https://api.translator.azure.cn`, `[Your Key]`|See [Azure](https://docs.azure.cn/en-us/ai-services/translator/text-translation-overview)|
|**Tencent**|`tencent`|`TENCENTCLOUD_SECRET_ID`, `TENCENTCLOUD_SECRET_KEY`|`[Your ID]`, `[Your Key]`|See [Tencent](https://www.tencentcloud.com/products/tmt?from_qcintl=122110104)|
Use `-s service` or `-s service:model` to specify service:
```bash
pdf2zh example.pdf -s openai:gpt-4o-mini
```
Or specify model with environment variables:
```bash
set OPENAI_MODEL=gpt-4o-mini
pdf2zh example.pdf -s openai
```
<h3 id="exceptions">Translate wih exceptions</h3>
Use regex to specify formula fonts and characters that need to be preserved:
```bash
pdf2zh example.pdf -f "(CM[^RT].*|MS.*|.*Ital)" -c "(\(|\||\)|\+|=|\d|[\u0080-\ufaff])"
```
Preserve `Latex`, `Mono`, `Code`, `Italic`, `Symbol` and `Math` fonts by default:
```bash
pdf2zh example.pdf -f "(CM[^R]|(MS|XY|MT|BL|RM|EU|LA|RS)[A-Z]|LINE|LCIRCLE|TeX-|rsfs|txsy|wasy|stmary|.*Mono|.*Code|.*Ital|.*Sym|.*Math)"
```
<h3 id="threads">Specify threads</h3>
Use `-t` to specify how many threads to use in translation:
```bash
pdf2zh example.pdf -t 1
```
<h2 id="todo">API</h2>
### Python
```python
from pdf2zh import translate, translate_stream
params = {"lang_in": "en", "lang_out": "zh", "service": "google", "thread": 4}
file_mono, file_dual = translate(files=["example.pdf"], **params)[0]
with open("example.pdf", "rb") as f:
stream_mono, stream_dual = translate_stream(stream=f.read(), **params)
```
### HTTP
```bash
pip install pdf2zh[backend]
pdf2zh --flask
pdf2zh --celery worker
```
```bash
curl http://localhost:11008/v1/translate -F "file=@example.pdf" -F "data={\"lang_in\":\"en\",\"lang_out\":\"zh\",\"service\":\"google\",\"thread\":4}"
{"id":"d9894125-2f4e-45ea-9d93-1a9068d2045a"}
curl http://localhost:11008/v1/translate/d9894125-2f4e-45ea-9d93-1a9068d2045a
{"info":{"n":13,"total":506},"state":"PROGRESS"}
curl http://localhost:11008/v1/translate/d9894125-2f4e-45ea-9d93-1a9068d2045a
{"state":"SUCCESS"}
curl http://localhost:11008/v1/translate/d9894125-2f4e-45ea-9d93-1a9068d2045a/mono --output example-mono.pdf
curl http://localhost:11008/v1/translate/d9894125-2f4e-45ea-9d93-1a9068d2045a/dual --output example-dual.pdf
curl http://localhost:11008/v1/translate/d9894125-2f4e-45ea-9d93-1a9068d2045a -X DELETE
```
<h2 id="todo">TODO</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>
- 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)
- 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.9",
"maintainer_email": null,
"keywords": null,
"author": null,
"author_email": "Byaidu <byaidux@gmail.com>",
"download_url": "https://files.pythonhosted.org/packages/4c/ee/7959cfe518a41e1ae7b2a290e40a16a30857ea53511890227ba92131a3e2/pdf2zh-1.8.8.tar.gz",
"platform": null,
"description": "<div align=\"center\">\n\nEnglish | [\u7b80\u4f53\u4e2d\u6587](README_zh-CN.md) | [\u65e5\u672c\u8a9e](README_ja-JP.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 <!-- License -->\n <a href=\"./LICENSE\">\n <img src=\"https://img.shields.io/github/license/Byaidu/PDFMathTranslate\"></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://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</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), [Telegram Group](https://t.me/+Z9_SgnxmsmA5NzBl) or [QQ Group](https://qm.qq.com/q/DixZCxQej0).\n\n<h2 id=\"updates\">Updates</h2>\n\n- [Nov. 26 2024] CLI now supports online file(s) *(by [@reycn](https://github.com/reycn))* \n- [Nov. 24 2024] [ONNX](https://github.com/onnx/onnx) support to reduce dependency sizes *(by [@Wybxc](https://github.com/Wybxc))* \n- [Nov. 23 2024] \ud83c\udf1f [Public Service](#demo) online! *(by [@Byaidu](https://github.com/Byaidu))* \n- [Nov. 23 2024] Firewall for preventing web bots *(by [@Byaidu](https://github.com/Byaidu))* \n- [Nov. 22 2024] GUI now supports Italian, and has been improved *(by [@Byaidu](https://github.com/Byaidu), [@reycn](https://github.com/reycn))* \n- [Nov. 22 2024] You can now share your deployed service to others *(by [@Zxis233](https://github.com/Zxis233))* \n- [Nov. 22 2024] Now supports Tencent Translation *(by [@hellofinch](https://github.com/hellofinch))* \n- [Nov. 21 2024] GUI now supports downloading dual-document *(by [@reycn](https://github.com/reycn))* \n- [Nov. 20 2024] \ud83c\udf1f [Demo](#demo) online! *(by [@reycn](https://github.com/reycn))* \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\">Public Service \ud83c\udf1f</h2>\n\n### Free Service (<https://pdf2zh.com/>)\n\nYou can try our [public service](https://pdf2zh.com/) online without installation. \n\n### Hugging Face Demo\n\nYou can try [our demo on HuggingFace](https://huggingface.co/spaces/reycn/PDFMathTranslate-Docker) without installation.\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\nWe provide four methods for using this project: [Commandline](#cmd), [Portable](#portable), [GUI](#gui), and [Docker](#docker).\n\n<h3 id=\"cmd\">Method I. Commandline</h3>\n\n 1. Python installed (3.8 <= version <= 3.12)\n 2. Install our package:\n\n ```bash\n pip install pdf2zh\n ```\n\n 3. 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<h3 id=\"portable\">Method II. Portable</h3>\n\nNo need to pre-install Python environment\n\nDownload [setup.bat](https://raw.githubusercontent.com/Byaidu/PDFMathTranslate/refs/heads/main/setup.bat) and double-click to run\n\n<h3 id=\"gui\">Method III. GUI</h3>\n\n1. Python installed (3.8 <= version <= 3.12)\n2. Install our package:\n\n ```bash\n pip install pdf2zh\n ```\n\n3. Start using in browser:\n\n ```bash\n pdf2zh -i\n ```\n\n4. If your browswer 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<h3 id=\"docker\">Method IV. Docker</h3>\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://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<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.\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](#partial) | `pdf2zh example.pdf -p 1` |\n| `-li` | [Source language](#languages) | `pdf2zh example.pdf -li en` |\n| `-lo` | [Target language](#languages) | `pdf2zh example.pdf -lo zh` |\n| `-s` | [Translation service](#services) | `pdf2zh example.pdf -s deepl` |\n| `-t` | [Multi-threads](#threads) | `pdf2zh example.pdf -t 1` |\n| `-o` | Output dir | `pdf2zh example.pdf -o output` |\n| `-f`, `-c` | [Exceptions](#exceptions) | `pdf2zh example.pdf -f \"(MS.*)\"` |\n| `--share` | Get gradio public link | `pdf2zh -i --share` |\n\n<h3 id=\"partial\">Full / partial document translation</h3>\n\n- Entire document\n\n ```bash\n pdf2zh example.pdf\n ```\n\n- Part of the document\n\n ```bash\n pdf2zh example.pdf -p 1-3,5\n ```\n\n<h3 id=\"language\">Specify source and target languages</h3>\n\nSee [Google Languages Codes](https://developers.google.com/admin-sdk/directory/v1/languages), [DeepL Languages Codes](https://developers.deepl.com/docs/resources/supported-languages)\n\n```bash\npdf2zh example.pdf -li en -lo ja\n```\n\n<h3 id=\"services\">Translate with Different Services</h3>\n\nThe table below outlines the required [environment variables](https://chatgpt.com/share/6734a83d-9d48-800e-8a46-f57ca6e8bcb4) for each translation service. Make sure to set them before using the respective service.\n\n|**Translator**|**Service**|**Environment Variables**|**Default Values**|**Notes**|\n|-|-|-|-|-|\n|**Google (Default)**|`google`|None|N/A|None|\n|**Bing**|`bing`|None|N/A|None|\n|**DeepL**|`deepl`|`DEEPL_SERVER_URL`,`DEEPL_AUTH_KEY`|`https://api.deepl.com`, `[Your Key]`|See [DeepL](https://support.deepl.com/hc/en-us/articles/360020695820-API-Key-for-DeepL-s-API)|\n|**DeepLX**|`deeplx`|`DEEPLX_ENDPOINT`|`https://api.deepl.com/translate`|See [DeepLX](https://github.com/OwO-Network/DeepLX)|\n|**Ollama**|`ollama`|`OLLAMA_HOST`, `OLLAMA_MODEL`|`http://127.0.0.1:11434`, `gemma2`|See [Ollama](https://github.com/ollama/ollama)|\n|**OpenAI**|`openai`|`OPENAI_BASE_URL`, `OPENAI_API_KEY`, `OPENAI_MODEL`|`https://api.openai.com/v1`, `[Your Key]`, `gpt-4o-mini`|See [OpenAI](https://platform.openai.com/docs/overview)|\n|**AzureOpenAI**|`azure-openai`|`AZURE_OPENAI_BASE_URL`, `AZURE_OPENAI_API_KEY`, `AZURE_OPENAI_MODEL`|`[Your Endpoint]`, `[Your Key]`, `gpt-4o-mini`|See [Azure OpenAI](https://learn.microsoft.com/zh-cn/azure/ai-services/openai/chatgpt-quickstart?tabs=command-line%2Cjavascript-keyless%2Ctypescript-keyless%2Cpython&pivots=programming-language-python)|\n|**Zhipu**|`zhipu`|`ZHIPU_API_KEY`, `ZHIPU_MODEL`|`[Your Key]`, `glm-4-flash`|See [Zhipu](https://open.bigmodel.cn/dev/api/thirdparty-frame/openai-sdk)|\n|**Silicon**|`silicon`|`SILICON_API_KEY`, `SILICON_MODEL`|`[Your Key]`, `Qwen/Qwen2.5-7B-Instruct`|See [SiliconCloud](https://docs.siliconflow.cn/quickstart)|\n|**Gemini**|`gemini`|`GEMINI_API_KEY`, `GEMINI_MODEL`|`[Your Key]`, `gemini-1.5-flash`|See [Gemini](https://ai.google.dev/gemini-api/docs/openai)|\n|**Azure**|`azure`|`AZURE_ENDPOINT`, `AZURE_API_KEY`|`https://api.translator.azure.cn`, `[Your Key]`|See [Azure](https://docs.azure.cn/en-us/ai-services/translator/text-translation-overview)|\n|**Tencent**|`tencent`|`TENCENTCLOUD_SECRET_ID`, `TENCENTCLOUD_SECRET_KEY`|`[Your ID]`, `[Your Key]`|See [Tencent](https://www.tencentcloud.com/products/tmt?from_qcintl=122110104)|\n\nUse `-s service` or `-s service:model` to specify service:\n\n```bash\npdf2zh example.pdf -s openai:gpt-4o-mini\n```\n\nOr specify model with environment variables:\n\n```bash\nset OPENAI_MODEL=gpt-4o-mini\npdf2zh example.pdf -s openai\n```\n\n<h3 id=\"exceptions\">Translate wih exceptions</h3>\n\nUse regex to specify formula fonts and characters that need to be preserved:\n\n```bash\npdf2zh example.pdf -f \"(CM[^RT].*|MS.*|.*Ital)\" -c \"(\\(|\\||\\)|\\+|=|\\d|[\\u0080-\\ufaff])\"\n```\n\nPreserve `Latex`, `Mono`, `Code`, `Italic`, `Symbol` and `Math` fonts by default:\n\n```bash\npdf2zh example.pdf -f \"(CM[^R]|(MS|XY|MT|BL|RM|EU|LA|RS)[A-Z]|LINE|LCIRCLE|TeX-|rsfs|txsy|wasy|stmary|.*Mono|.*Code|.*Ital|.*Sym|.*Math)\"\n```\n\n<h3 id=\"threads\">Specify threads</h3>\n\nUse `-t` to specify how many threads to use in translation:\n\n```bash\npdf2zh example.pdf -t 1\n```\n\n<h2 id=\"todo\">API</h2>\n\n### Python\n\n```python\nfrom pdf2zh import translate, translate_stream\n\nparams = {\"lang_in\": \"en\", \"lang_out\": \"zh\", \"service\": \"google\", \"thread\": 4}\nfile_mono, file_dual = translate(files=[\"example.pdf\"], **params)[0]\nwith open(\"example.pdf\", \"rb\") as f:\n stream_mono, stream_dual = translate_stream(stream=f.read(), **params)\n```\n\n### HTTP\n\n```bash\npip install pdf2zh[backend]\npdf2zh --flask\npdf2zh --celery worker\n```\n\n```bash\ncurl http://localhost:11008/v1/translate -F \"file=@example.pdf\" -F \"data={\\\"lang_in\\\":\\\"en\\\",\\\"lang_out\\\":\\\"zh\\\",\\\"service\\\":\\\"google\\\",\\\"thread\\\":4}\"\n{\"id\":\"d9894125-2f4e-45ea-9d93-1a9068d2045a\"}\n\ncurl http://localhost:11008/v1/translate/d9894125-2f4e-45ea-9d93-1a9068d2045a\n{\"info\":{\"n\":13,\"total\":506},\"state\":\"PROGRESS\"}\n\ncurl http://localhost:11008/v1/translate/d9894125-2f4e-45ea-9d93-1a9068d2045a\n{\"state\":\"SUCCESS\"}\n\ncurl http://localhost:11008/v1/translate/d9894125-2f4e-45ea-9d93-1a9068d2045a/mono --output example-mono.pdf\n\ncurl http://localhost:11008/v1/translate/d9894125-2f4e-45ea-9d93-1a9068d2045a/dual --output example-dual.pdf\n\ncurl http://localhost:11008/v1/translate/d9894125-2f4e-45ea-9d93-1a9068d2045a -X DELETE\n```\n\n<h2 id=\"todo\">TODO</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- 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- 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": "AGPL-3.0",
"summary": "Latex PDF Translator",
"version": "1.8.8",
"project_urls": {
"Homepage": "https://github.com/Byaidu/PDFMathTranslate"
},
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "84376a12c712ce174ea72efd84742f0df433d5d5829072eb6a7cad02389f7c5a",
"md5": "bcedd82a202881794a467ae402be1c8f",
"sha256": "c848581881ad5be0250f2df156a501ff81094a18f364352dc4716914f0f5f8c3"
},
"downloads": -1,
"filename": "pdf2zh-1.8.8-py3-none-any.whl",
"has_sig": false,
"md5_digest": "bcedd82a202881794a467ae402be1c8f",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": "<3.13,>=3.9",
"size": 45337,
"upload_time": "2024-12-15T14:30:45",
"upload_time_iso_8601": "2024-12-15T14:30:45.941337Z",
"url": "https://files.pythonhosted.org/packages/84/37/6a12c712ce174ea72efd84742f0df433d5d5829072eb6a7cad02389f7c5a/pdf2zh-1.8.8-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "4cee7959cfe518a41e1ae7b2a290e40a16a30857ea53511890227ba92131a3e2",
"md5": "8bc075c9e8cc3911fdecff720b6e18f1",
"sha256": "1fef12360bd10ddd611a9e9e35a9f4dfc0da6f828b1ade51fe6d2a5e781de11b"
},
"downloads": -1,
"filename": "pdf2zh-1.8.8.tar.gz",
"has_sig": false,
"md5_digest": "8bc075c9e8cc3911fdecff720b6e18f1",
"packagetype": "sdist",
"python_version": "source",
"requires_python": "<3.13,>=3.9",
"size": 4093208,
"upload_time": "2024-12-15T14:30:49",
"upload_time_iso_8601": "2024-12-15T14:30:49.368199Z",
"url": "https://files.pythonhosted.org/packages/4c/ee/7959cfe518a41e1ae7b2a290e40a16a30857ea53511890227ba92131a3e2/pdf2zh-1.8.8.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-12-15 14:30:49",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "Byaidu",
"github_project": "PDFMathTranslate",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "pdf2zh"
}
