history-museum/wxocr
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

doc

Browse Source
This commit is contained in:
golangboy 2025-03-25 19:22:46 +08:00
parent 6109b9834f
commit 3909467809
2 changed files with 214 additions and 52 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

106
README.MD
View File

@ -1,44 +1,46 @@
# WeChat OCR API Docker
A Dockerized REST API service for text recognition using WeChat's OCR engine.
基于微信OCR引擎的Docker化REST API服务。
## Overview
[English](README_EN.MD) | 中文
This project wraps the WeChat OCR functionality from the excellent [wechat-ocr](https://github.com/swigger/wechat-ocr) project into a simple REST API service that can be easily deployed using Docker. It allows you to perform optical character recognition on images by leveraging WeChat's powerful OCR capabilities.
## 概述
## ⚠️ Warning
本项目将优秀的[wechat-ocr](https://github.com/swigger/wechat-ocr)项目中的微信OCR功能包装成一个简单的REST API服务，可以使用Docker轻松部署。它允许您利用微信强大的OCR功能对图像进行文字识别。
**This is an open-source project intended for learning and communication purposes only. Please do not use it for commercial activities. Users are solely responsible for any consequences resulting from improper use of this project.**
## ⚠️ 警告
**Copyright Disclaimer:** This project is merely a containerization of an existing open-source project. If you believe this repository infringes upon your copyright or intellectual property rights, please contact the repository owner immediately, and the repository will be promptly removed. We respect intellectual property rights and have no intention of infringing on them.
**这是一个仅用于学习和交流目的的开源项目。请勿将其用于商业活动。用户对因不当使用本项目而导致的任何后果负有全部责任。**
## Acknowledgements
**版权声明：** 本项目仅是对现有开源项目的容器化。如果您认为本仓库侵犯了您的版权或知识产权，请立即联系仓库所有者，仓库将会被迅速删除。我们尊重知识产权，无意侵犯任何权利。
This project would not be possible without the work of [swigger](https://github.com/swigger) and their [wechat-ocr](https://github.com/swigger/wechat-ocr) project. Their efforts in reverse-engineering and creating a usable interface for WeChat's OCR functionality form the foundation of this service.
## 致谢
## Quick Start
本项目的实现离不开[swigger](https://github.com/swigger)及其[wechat-ocr](https://github.com/swigger/wechat-ocr)项目的工作。他们在逆向工程和创建微信OCR功能可用接口方面的努力构成了本服务的基础。
### Using Docker
## 快速开始
### 使用Docker
```bash
# Pull the image
# 拉取镜像
docker pull golangboyme/wxocr
# Run the container
# 运行容器
docker run -d -p 5000:5000 --name wechat-ocr-api golangboyme/wxocr
```
### API Usage
### API使用
Send a POST request to `/ocr` with a JSON payload containing your base64-encoded image:
向`/ocr`发送POST请求，JSON负载中包含您的base64编码图像：
```bash
curl -X POST http://localhost:5000/ocr \
-H "Content-Type: application/json" \
-d '{"image": "BASE64_ENCODED_IMAGE_DATA"}'
-d '{"image": "BASE64编码的图像数据"}'
```
#### Example Response
#### 示例响应
```json
{
@ -67,9 +69,9 @@ curl -X POST http://localhost:5000/ocr \
}
```
### Python Client Example
### Python客户端示例
Here's a simple Python client to use the OCR API:
这是一个简单的Python客户端，用于使用OCR API：
```python
import requests
@ -78,13 +80,13 @@ import os
def ocr_recognize(image_path=None, image_url=None, api_url="http://localhost:5000/ocr"):
"""
Send an image to the OCR API service and get the recognition results.
Use either image_path or image_url (one is required).
将图像发送到OCR API服务并获取识别结果。
使用image_path或image_url（需要提供其中一个）。
"""
# Get image data
# 获取图像数据
if image_path:
if not os.path.exists(image_path):
print(f"Error: Local image not found: {image_path}")
print(f"错误：未找到本地图像：{image_path}")
return
with open(image_path, "rb") as image_file:
img_data = image_file.read()
@ -94,65 +96,65 @@ def ocr_recognize(image_path=None, image_url=None, api_url="http://localhost:500
response.raise_for_status()
img_data = response.content
except Exception as e:
print(f"Failed to download image: {str(e)}")
print(f"下载图像失败：{str(e)}")
return
else:
print("Please provide either image_path or image_url")
print("请提供image_path或image_url")
return
# Convert image to base64
# 将图像转换为base64
base64_image = base64.b64encode(img_data).decode('utf-8')
# Send request to API
# 发送请求到API
try:
response = requests.post(api_url, json={"image": base64_image})
response.raise_for_status()
return response.json()
except Exception as e:
print(f"API request failed: {str(e)}")
print(f"API请求失败：{str(e)}")
return None
# Example usage
# 使用示例
if __name__ == "__main__":
# Local image example
# 本地图像示例
result = ocr_recognize(image_path="ocrtest.png")
if result:
print(result)
# URL image example (uncomment to use)
# URL图像示例（取消注释以使用）
# result = ocr_recognize(image_url="https://example.com/image.png")
```
## Project Structure
## 项目结构
- `main.py`: The Flask API service that handles OCR requests
- `opt/wechat/wxocr`: WeChat OCR binary
- `opt/wechat/`: WeChat runtime dependencies
- `main.py`：处理OCR请求的Flask API服务
- `opt/wechat/wxocr`：微信OCR二进制文件
- `opt/wechat/`：微信运行时依赖
## Technical Details
## 技术细节
This service uses a Flask application to provide a REST API interface to the WeChat OCR functionality. When an image is submitted:
该服务使用Flask应用程序为微信OCR功能提供REST API接口。当提交图像时：
1. The base64-encoded image is decoded
2. A temporary file is created
3. The image is processed by the WeChat OCR engine via the wcocr Python binding
4. Results are returned in JSON format
5. Temporary files are cleaned up
1. 解码base64编码的图像
2. 创建临时文件
3. 通过wcocr Python绑定由微信OCR引擎处理图像
4. 以JSON格式返回结果
5. 清理临时文件
## Limitations
## 限制
- Currently only supports PNG images (can be extended if needed)
- Depends on WeChat's OCR binaries which may be updated by WeChat
- 目前仅支持PNG图像（如需要可以扩展）
- 依赖于可能被微信更新的微信OCR二进制文件
## License
## 许可证
This project is provided under MIT License with the following additional terms:
本项目根据MIT许可证提供，并附加以下条款：
1. The repository owner disclaims all liability for any use of this software.
2. By using, copying, modifying, or distributing this software, you acknowledge that any actions taken with this software are solely your own responsibility.
3. Any use of this repository and its contents is done at the user's own risk and discretion.
4. The repository owner is not responsible for any consequences, legal or otherwise, resulting from the use of this software.
1. 仓库所有者对本软件的任何使用不承担任何责任。
2. 通过使用、复制、修改或分发本软件，您承认使用本软件的任何行为完全由您自行负责。
3. 对本仓库及其内容的任何使用均由用户自行承担风险和责任。
4. 仓库所有者对使用本软件产生的任何后果（法律上的或其他方面的）不承担责任。
## Contributing
## 贡献
Contributions are welcome! Please feel free to submit a Pull Request.
欢迎贡献！请随时提交Pull Request。

160
README_EN.MD Normal file
View File

@ -0,0 +1,160 @@
# WeChat OCR API Docker
A Dockerized REST API service for text recognition using WeChat's OCR engine.
中文 | [English](README_EN.MD)
## Overview
This project wraps the WeChat OCR functionality from the excellent [wechat-ocr](https://github.com/swigger/wechat-ocr) project into a simple REST API service that can be easily deployed using Docker. It allows you to perform optical character recognition on images by leveraging WeChat's powerful OCR capabilities.
## ⚠️ Warning
**This is an open-source project intended for learning and communication purposes only. Please do not use it for commercial activities. Users are solely responsible for any consequences resulting from improper use of this project.**
**Copyright Disclaimer:** This project is merely a containerization of an existing open-source project. If you believe this repository infringes upon your copyright or intellectual property rights, please contact the repository owner immediately, and the repository will be promptly removed. We respect intellectual property rights and have no intention of infringing on them.
## Acknowledgements
This project would not be possible without the work of [swigger](https://github.com/swigger) and their [wechat-ocr](https://github.com/swigger/wechat-ocr) project. Their efforts in reverse-engineering and creating a usable interface for WeChat's OCR functionality form the foundation of this service.
## Quick Start
### Using Docker
```bash
# Pull the image
docker pull golangboyme/wxocr
# Run the container
docker run -d -p 5000:5000 --name wechat-ocr-api golangboyme/wxocr
```
### API Usage
Send a POST request to `/ocr` with a JSON payload containing your base64-encoded image:
```bash
curl -X POST http://localhost:5000/ocr \
-H "Content-Type: application/json" \
-d '{"image": "BASE64_ENCODED_IMAGE_DATA"}'
```
#### Example Response
```json
{
"errcode": 0,
"height": 72,
"width": 410,
"imgpath": "temp/5726fe7b-25d6-43a6-a50d-35b5f668fbb6.png",
"ocr_response": [
{
"text": "aacss",
"left": 80.63632202148438,
"top": 29.634929656982422,
"right": 236.47093200683594,
"bottom": 55.28932189941406,
"rate": 0.9997046589851379
},
{
"text": "xxzsa",
"left": 312.625,
"top": 30.75,
"right": 395.265625,
"bottom": 55.09375,
"rate": 0.997739315032959
}
]
}
```
### Python Client Example
Here's a simple Python client to use the OCR API:
```python
import requests
import base64
import os
def ocr_recognize(image_path=None, image_url=None, api_url="http://localhost:5000/ocr"):
"""
Send an image to the OCR API service and get the recognition results.
Use either image_path or image_url (one is required).
"""
# Get image data
if image_path:
if not os.path.exists(image_path):
print(f"Error: Local image not found: {image_path}")
return
with open(image_path, "rb") as image_file:
img_data = image_file.read()
elif image_url:
try:
response = requests.get(image_url)
response.raise_for_status()
img_data = response.content
except Exception as e:
print(f"Failed to download image: {str(e)}")
return
else:
print("Please provide either image_path or image_url")
return
# Convert image to base64
base64_image = base64.b64encode(img_data).decode('utf-8')
# Send request to API
try:
response = requests.post(api_url, json={"image": base64_image})
response.raise_for_status()
return response.json()
except Exception as e:
print(f"API request failed: {str(e)}")
return None
# Example usage
if __name__ == "__main__":
# Local image example
result = ocr_recognize(image_path="ocrtest.png")
if result:
print(result)
# URL image example (uncomment to use)
# result = ocr_recognize(image_url="https://example.com/image.png")
```
## Project Structure
- `main.py`: The Flask API service that handles OCR requests
- `opt/wechat/wxocr`: WeChat OCR binary
- `opt/wechat/`: WeChat runtime dependencies
## Technical Details
This service uses a Flask application to provide a REST API interface to the WeChat OCR functionality. When an image is submitted:
1. The base64-encoded image is decoded
2. A temporary file is created
3. The image is processed by the WeChat OCR engine via the wcocr Python binding
4. Results are returned in JSON format
5. Temporary files are cleaned up
## Limitations
- Currently only supports PNG images (can be extended if needed)
- Depends on WeChat's OCR binaries which may be updated by WeChat
## License
This project is provided under MIT License with the following additional terms:
1. The repository owner disclaims all liability for any use of this software.
2. By using, copying, modifying, or distributing this software, you acknowledge that any actions taken with this software are solely your own responsibility.
3. Any use of this repository and its contents is done at the user's own risk and discretion.
4. The repository owner is not responsible for any consequences, legal or otherwise, resulting from the use of this software.
## Contributing
Contributions are welcome! Please feel free to submit a Pull Request.