update docs

Makefile

@@ -39,7 +39,7 @@ upload:
 
 # 开启 OCR HTTP 服务
 serve:
-	cnocr serve -p 8000 --reload
+	cnocr serve -p 8501 --reload
 
 # 开启监控截屏文件夹的守护进程
 daemon:

README.md

@@ -236,6 +236,67 @@ pip install cnocr -i https://pypi.doubanio.com/simple
 
 
 
+
+
+## HTTP服务
+
+CnOCR **V2.2.1** 加入了基于 FastAPI 的HTTP服务。开启服务需要安装几个额外的包，可以使用以下命令安装：
+
+```bash
+pip install cnocr[serve]
+```
+
+
+
+安装完成后，可以通过以下命令启动HTTP服务（**`-p`** 后面的数字是**端口**，可以根据需要自行调整）：
+
+```bash
+cnocr serve -p 8501
+```
+
+
+
+服务开启后，可以使用以下方式调用服务。
+
+
+
+### 命令行
+
+比如待识别文件为 `docs/examples/huochepiao.jpeg`，如下使用 curl 调用服务：
+
+```bash
+> curl -F image=@docs/examples/huochepiao.jpeg http://0.0.0.0:8501/ocr
+```
+
+
+
+### Python
+
+使用如下方式调用服务：
+
+```python
+image_fp = 'docs/examples/huochepiao.jpeg'
+r = requests.post(
+    'http://0.0.0.0:8501/ocr', files={'image': (image_fp, open(image_fp, 'rb'), 'image/png')},
+)
+ocr_out = r.json()['results']
+print(ocr_out)
+```
+
+
+
+具体也可参考文件 [scripts/screenshot_daemon_with_server.py](scripts/screenshot_daemon_with_server.py) 。 
+
+
+
+### 其他语言
+
+请参照 curl 的调用方式自行实现。
+
+
+
+
+
 ## 可使用的模型
 
 ### 可使用的检测模型

docs/RELEASE.md

 # Release Notes
 
+### Update 2022.08.21: 发布 cnocr V2.2.1
+
+主要变更：
+
+* 修复了一些bug。
+* 加入了基于 FastAPI 的HTTP服务，使用命令 `cnocr serve` 启动HTTP服务，具体见 [安装说明](install.md)。
+* 加入了一些工具脚本，如对截屏图片进行OCR，具体见[cnocr/scripts](https://github.com/breezedeus/CnOCR/tree/master/scripts)。
+
+
+
 ### Update 2022.07.25: 发布 cnocr V2.2
 
 主要变更：

docs/index.md

@@ -222,6 +222,65 @@ print(out)
 
 
 
+## HTTP服务
+
+CnOCR **V2.2.1** 加入了基于 FastAPI 的HTTP服务。开启服务需要安装几个额外的包，可以使用以下命令安装：
+
+```bash
+pip install cnocr[serve]
+```
+
+
+
+安装完成后，可以通过以下命令启动HTTP服务（**`-p`** 后面的数字是**端口**，可以根据需要自行调整）：
+
+```bash
+cnocr serve -p 8501
+```
+
+
+
+服务开启后，可以使用以下方式调用服务。
+
+
+
+### 命令行
+
+比如待识别文件为 `docs/examples/huochepiao.jpeg`，如下使用 curl 调用服务：
+
+```bash
+> curl -F image=@docs/examples/huochepiao.jpeg http://0.0.0.0:8501/ocr
+```
+
+
+
+### Python
+
+使用如下方式调用服务：
+
+```python
+image_fp = 'docs/examples/huochepiao.jpeg'
+r = requests.post(
+    'http://0.0.0.0:8501/ocr', files={'image': (image_fp, open(image_fp, 'rb'), 'image/png')},
+)
+ocr_out = r.json()['results']
+print(ocr_out)
+```
+
+
+
+具体也可参考文件 [scripts/screenshot_daemon_with_server.py](https://github.com/breezedeus/CnOCR/tree/master/scripts/screenshot_daemon_with_server.py) 。 
+
+
+
+### 其他语言
+
+请参照 curl 的调用方式自行实现。
+
+
+
+
+
 ## 其他文档
 
 * [自己训练模型](train.md)

docs/install.md

@@ -26,6 +26,28 @@ pip install cnocr -i https://pypi.doubanio.com/simple
 
 
 
+### 包含API接口安装
+
+CnOCR **V2.2.1** 加入了基于 FastAPI 的HTTP服务。开启服务需要安装几个额外的包，可以使用以下命令安装：
+
+```bash
+pip install cnocr[serve]
+```
+
+
+
+安装完成后，可以通过以下命令启动HTTP服务（**`-p`** 后面的数字是**端口**，可以根据需要自行调整）：
+
+```bash
+cnocr serve -p 8501
+```
+
+
+
+服务的调用方式请参考 [首页/HTTP服务](index.md) 。
+
+
+
 如遇到安装问题，欢迎在 [Github](https://github.com/breezedeus/cnocr)、 知识星球[**CnOCR/CnSTD私享群**](https://t.zsxq.com/FEYZRJQ) 或者 微信交流群反馈给作者 [breezedeus](https://github.com/breezedeus) 。
 
 

scripts/screenshot_daemon_with_server.py

@@ -18,7 +18,7 @@
 # under the License.
 
 # 也可以下调用命令在命令行调用开启的OCR服务：
-# > curl -F image=@docs/examples/huochepiao.jpeg http://0.0.0.0:8000/ocr
+# > curl -F image=@docs/examples/huochepiao.jpeg http://0.0.0.0:8501/ocr
 
 import os
 import time
@@ -32,7 +32,7 @@ from cnocr.utils import set_logger
 logger = set_logger(log_level='DEBUG')
 
 
-SERVICE_URL = os.getenv("CNOCR_SERVICE", 'http://0.0.0.0:8000/ocr')
+SERVICE_URL = os.getenv("CNOCR_SERVICE", 'http://0.0.0.0:8501/ocr')
 SCREENSHOT_DIR = os.getenv(
     "SCREENSHOT_DIR", '/Users/king/Pictures/screenshot_from_xnip'
 )