/Umi-OCR_runtime_linux

Umi-OCR Linux 运行环境

Primary LanguagePythonMIT LicenseMIT

Umi-OCR

Umi-OCR Linux 运行环境

本仓库为 Umi-OCR 的代码 提供 Linux 运行环境。

Note

Umi-OCR Linux 处于测试阶段，使用时可能遇到一些问题。
欢迎 Linux 用户参与测试、提出Issue、贡献PR。

预览.png

已通过测试的系统

  • Ubuntu 22.04
  • Debian 12.5

Umi-OCR Linux 兼容情况

经验证，可正常使用的功能：

  • 批量OCR
  • 截图OCR（不支持Wayland，仅在x会话下可用）
  • 粘贴图片OCR
  • 批量文档OCR
  • 二维码生成/识别
  • HTTP 接口
  • 命令行调用
  • 一键添加到桌面、开始菜单快捷方式

受限的功能：

  • 不支持 一键添加开机自启。（必须手动设置）
  • 不支持 批量任务完成后自动关机/待机。
  • 在x会话下截图受限。
  • 目前需要较繁琐的方式手动部署项目。（未来将提供更方便的发行版）

硬件要求

Note

当前 Umi-OCR-Linux 仅具有 PaddleOCR-json 这一种 OCR 引擎，它只支持具有 AVX指令集 的CPU。
未来，我们会添加更多的 OCR 引擎，支持更多硬件平台。

检查CPU兼容性：

lscpu | grep avx

如果CPU支持AVX指令集，则会输出一行很长的结果，其中可以找到 avx 的字样，类似如下（省略部分内容）：

Flags:          ... avx ... avx2 ...

如果看不到任何输出，这表明当前CPU不支持AVX指令集，暂时无法使用 Umi-OCR-Linux 。

项目部署流程

创建项目目录

mkdir Umi-OCR_Project
cd Umi-OCR_Project

拉取最新源码

git clone --single-branch --branch main https://github.com/hiroi-sora/Umi-OCR.git
git clone https://github.com/hiroi-sora/Umi-OCR_runtime_linux.git

安装工具

sudo apt-get install python3-dev
sudo apt-get install gcc

拷贝Linux环境所需脚本

Umi-OCR_runtime_linux 仓库中的所有文件，拷贝到主仓库 Umi-OCR 中。（不覆盖）

cp -r -n Umi-OCR_runtime_linux/{.,}* Umi-OCR
chmod +x Umi-OCR/umi-ocr.sh

（可选） Python 3.10

检查当前版本：

python --version

Umi-OCR 依赖 PySide2>=5.15 库，它需要 Python 3.8 ~ 3.10 的环境。如果系统中没有版本符合的Python，那么请根据下列步骤，通过 pyenv 工具，安装 Python 3.10 。（也可以使用 conda 等工具安装。）

安装 pyenv ：

curl https://pyenv.run | bash

echo 'export PYENV_ROOT="$HOME/.pyenv"' >> ~/.bashrc
echo 'command -v pyenv >/dev/null || export PATH="$PYENV_ROOT/bin:$PATH"' >> ~/.bashrc
echo 'eval "$(pyenv init -)"' >> ~/.bashrc

exec "$SHELL"

安装构建工具：

sudo apt install \
        make wget llvm build-essential libbz2-dev \
        libncurses5-dev libgdbm-dev libnss3-dev \
        libssl-dev libffi-dev libreadline-dev libsqlite3-dev \
        zlib1g-dev liblzma-dev xz-utils tk-dev

安装Python：

pyenv install 3.10

设置当前Shell的Python版本（不影响系统全局）：

pyenv shell 3.10

创建Python虚拟环境，安装依赖库

cd Umi-OCR/UmiOCR-data
python3 --version  # 确保Python版本为 3.8 ~ 3.10
python3 -m venv venv
source venv/bin/activate
pip3 install -r ../requirements.txt

放置 PaddleOCR-json 插件

安装解压工具 p7zip ：

sudo apt-get install p7zip-full

（确保当前在 Umi-OCR/UmiOCR-data 目录下）

创建并转到插件目录：

mkdir -p plugins
cd plugins

下载 linux_x64_PaddleOCR-json_v140_dev 插件并解压：

wget https://github.com/hiroi-sora/Umi-OCR_plugins/releases/download/2.1.3_dev/linux_x64_PaddleOCR-json_v140_dev.7z
7z x linux_x64_PaddleOCR-json_v140_dev.7z

回到 Umi-OCR 目录中

cd ../..

启动！

通过命令行启动：

./umi-ocr.sh

成功启动并进行OCR，如下所示：

image

注： umi-ocr.sh 为程序启动脚本，允许重命名。
如果希望像普通桌面软件一样，双击运行程序、且不显示控制台窗口，可以在全局设置中创建 桌面/开始菜单快捷方式 ，通过快捷方式图标启动软件。

如果屏幕截图功能不可用（比如截图界面是纯黑的），进行下述操作：

（可选）将显示服务器协议设置为 X 会话

在较新的 Linux 桌面发行版中，默认使用 Wayland 显示服务器协议。由于 Wayland 对权限管理较为严格，QT 框架无法抓取屏幕截图，或者只能获取到纯黑的图像。

如果您需要使用截图功能，请将显示服务器协议切换为 X 协议（如 Xorg）。以下是在 Ubuntu、Debian 等系统中进行切换的方法：

  1. 在登录界面，点击右下角的齿轮图标。
  2. 选择 Xorg 选项。
  3. 重新登录系统。

如果已经登录了系统，可以先注销，然后按照上述步骤切换到 Xorg。

如果不需要使用截图功能，则无需进行此操作。

image

创建快捷方式

可以在全局设置中一键创建桌面或开始菜单快捷方式。通过快捷方式启动软件时，不会显示命令行窗口。

命令行指令

参考主仓库 命令行手册 ，将调用对象换成 umi-ocr.sh 。如：

./umi-ocr.sh  --screenshot

Note

注意，由于Linux平台的会话机制，冷启动时（即 Umi-OCR 未在运行），可能不会执行指令，或者输出多余的调试信息。
建议先启动 Umi-OCR （通过命令行或者快捷方式启动均可），确保主进程已经运行。再在新的会话中，使用命令行指令来控制。

（可选）编辑器

  • 如果需要对代码进行二次开发或调试，推荐使用 VS Code 编辑器。
  • 插件推荐：
  • 本仓库提供了 .vscode 项目配置文件。

待进行的开发工作

  • 将项目打包为体积小、易于使用的软件包。