ncnn-ocr 0.1.0__tar.gz

ncnn_ocr-0.1.0/.github/scripts/build_ncnn.sh

@@ -0,0 +1,23 @@
+#!/usr/bin/env bash
+set -euo pipefail
+
+NCNN_TAG="${NCNN_TAG:-20241226}"
+NCNN_DIR="${NCNN_DIR:-$HOME/.local/ncnn}"
+SRC_DIR="${RUNNER_TEMP:-/tmp}/ncnn-src"
+BUILD_DIR="${RUNNER_TEMP:-/tmp}/ncnn-build"
+
+if [[ -f "${NCNN_DIR}/lib/cmake/ncnn/ncnnConfig.cmake" ]]; then
+  echo "ncnn already installed at ${NCNN_DIR}"
+  exit 0
+fi
+
+git clone --depth 1 --branch "${NCNN_TAG}" https://github.com/Tencent/ncnn.git "${SRC_DIR}"
+cmake -S "${SRC_DIR}" -B "${BUILD_DIR}" \
+  -DNCNN_VULKAN=OFF \
+  -DNCNN_BUILD_TOOLS=OFF \
+  -DNCNN_BUILD_EXAMPLES=OFF \
+  -DCMAKE_INSTALL_PREFIX="${NCNN_DIR}"
+cmake --build "${BUILD_DIR}" -j"$(nproc)"
+cmake --install "${BUILD_DIR}"
+
+echo "NCNN_DIR=${NCNN_DIR}" >> "${GITHUB_ENV:-/dev/null}"

ncnn_ocr-0.1.0/.github/scripts/set_version_from_tag.sh

@@ -0,0 +1,22 @@
+#!/usr/bin/env bash
+set -euo pipefail
+
+TAG="${GITHUB_REF_NAME:-}"
+if [[ -z "$TAG" ]]; then
+  echo "GITHUB_REF_NAME is not set" >&2
+  exit 1
+fi
+
+VERSION="${TAG#v}"
+if [[ ! "$VERSION" =~ ^[0-9]+\.[0-9]+\.[0-9]+([a-zA-Z0-9.-]*)?$ ]]; then
+  echo "Invalid release tag: $TAG (expected vX.Y.Z)" >&2
+  exit 1
+fi
+
+echo "Setting package version to $VERSION"
+
+sed -i.bak "s/^version = .*/version = \"$VERSION\"/" pyproject.toml
+sed -i.bak "s/^__version__ = .*/__version__ = \"$VERSION\"/" src/ncnn_ocr/__init__.py
+rm -f pyproject.toml.bak src/ncnn_ocr/__init__.py.bak
+
+echo "PROJECT_VERSION=$VERSION" >> "${GITHUB_ENV:-/dev/null}"

ncnn_ocr-0.1.0/.github/workflows/ci.yml

@@ -0,0 +1,99 @@
+name: CI
+
+# Push to main / PRs: test + build wheels only. Does NOT publish to PyPI.
+# PyPI publish happens only in release.yml on version tags (v*).
+
+on:
+  push:
+    branches: [main, master]
+  pull_request:
+
+env:
+  NCNN_TAG: "20241226"
+  NCNN_DIR: ${{ github.workspace }}/.ncnn
+
+jobs:
+  test-python:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+
+      - uses: actions/setup-python@v5
+        with:
+          python-version: "3.12"
+
+      - name: Install test dependencies
+        run: |
+          python -m pip install --upgrade pip
+          pip install pytest numpy opencv-python-headless huggingface-hub pillow
+
+      - name: Run unit tests
+        run: PYTHONPATH=src pytest -q tests/test_package.py tests/test_arabic.py
+
+  build-linux:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Install system dependencies
+        run: |
+          sudo apt-get update
+          sudo apt-get install -y cmake libopencv-dev libomp-dev git
+
+      - name: Build and install ncnn
+        run: bash .github/scripts/build_ncnn.sh
+
+      - uses: actions/setup-python@v5
+        with:
+          python-version: "3.12"
+
+      - name: Build and test wheel
+        env:
+          CMAKE_PREFIX_PATH: ${{ env.NCNN_DIR }}
+        run: |
+          python -m pip install --upgrade pip build "scikit-build-core>=0.10" "pybind11>=2.11" pytest auditwheel
+          pip install numpy opencv-python-headless huggingface-hub pillow
+          python -m build --wheel
+          auditwheel repair dist/*.whl -w wheelhouse
+          rm -f dist/*.whl
+          mv wheelhouse/*.whl dist/
+          rmdir wheelhouse
+          pip install dist/*.whl
+          python -c "from ncnn_ocr import NATIVE_AVAILABLE; assert NATIVE_AVAILABLE"
+          pytest -q tests/test_integration.py
+
+      - uses: actions/upload-artifact@v4
+        with:
+          name: ci-wheel-linux-x86_64
+          path: dist/*.whl
+          retention-days: 7
+
+  build-macos:
+    runs-on: macos-14
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Install system dependencies
+        run: brew install cmake ncnn opencv@4 libomp
+
+      - uses: actions/setup-python@v5
+        with:
+          python-version: "3.12"
+
+      - name: Build and test wheel
+        env:
+          CMAKE_PREFIX_PATH: /opt/homebrew/opt/ncnn:/opt/homebrew/opt/opencv@4:/opt/homebrew/opt/libomp
+          OpenCV_DIR: /opt/homebrew/opt/opencv@4/lib/cmake/opencv4
+        run: |
+          python -m pip install --upgrade pip build "scikit-build-core>=0.10" "pybind11>=2.11" pytest
+          pip install numpy opencv-python-headless huggingface-hub pillow
+          python -m build --wheel
+          pip install dist/*.whl
+          python -c "from ncnn_ocr import NATIVE_AVAILABLE; assert NATIVE_AVAILABLE"
+          pytest -q tests/test_integration.py
+
+      - uses: actions/upload-artifact@v4
+        with:
+          name: ci-wheel-macos-arm64
+          path: dist/*.whl
+          retention-days: 7

ncnn_ocr-0.1.0/.github/workflows/release.yml

@@ -0,0 +1,163 @@
+name: Release
+
+# PyPI publish ONLY on version tags (e.g. v0.1.0).
+# Never runs on push to main — see ci.yml for build-only CI.
+
+on:
+  push:
+    tags:
+      - "v*"
+
+permissions:
+  contents: read
+  id-token: write
+
+env:
+  NCNN_TAG: "20241226"
+  NCNN_DIR: ${{ github.workspace }}/.ncnn
+
+jobs:
+  test:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+
+      - uses: actions/setup-python@v5
+        with:
+          python-version: "3.12"
+
+      - name: Install test dependencies
+        run: |
+          python -m pip install --upgrade pip
+          pip install pytest numpy opencv-python-headless huggingface-hub pillow
+
+      - name: Run unit tests
+        run: PYTHONPATH=src pytest -q tests/test_package.py tests/test_arabic.py
+
+  build-linux:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Set version from tag
+        run: bash .github/scripts/set_version_from_tag.sh
+
+      - name: Install system dependencies
+        run: |
+          sudo apt-get update
+          sudo apt-get install -y cmake libopencv-dev libomp-dev git
+
+      - name: Build and install ncnn
+        run: bash .github/scripts/build_ncnn.sh
+
+      - uses: actions/setup-python@v5
+        with:
+          python-version: "3.12"
+
+      - name: Build wheel
+        env:
+          CMAKE_PREFIX_PATH: ${{ env.NCNN_DIR }}
+        run: |
+          python -m pip install --upgrade pip build "scikit-build-core>=0.10" "pybind11>=2.11"
+          python -m build --wheel
+
+      - name: Repair wheel for PyPI (manylinux)
+        run: |
+          python -m pip install auditwheel
+          auditwheel repair dist/*.whl -w wheelhouse
+          rm -f dist/*.whl
+          mv wheelhouse/*.whl dist/
+          rmdir wheelhouse
+
+      - name: Smoke test wheel
+        run: |
+          pip install dist/*.whl opencv-python-headless huggingface-hub pillow pytest
+          python -c "from ncnn_ocr import OCR, NATIVE_AVAILABLE; assert NATIVE_AVAILABLE"
+          python -m pytest -q tests/test_integration.py
+
+      - uses: actions/upload-artifact@v4
+        with:
+          name: wheel-linux-x86_64
+          path: dist/*.whl
+
+  build-macos:
+    runs-on: macos-14
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Set version from tag
+        run: bash .github/scripts/set_version_from_tag.sh
+
+      - name: Install system dependencies
+        run: |
+          brew install cmake ncnn opencv@4 libomp
+
+      - uses: actions/setup-python@v5
+        with:
+          python-version: "3.12"
+
+      - name: Build wheel
+        env:
+          CMAKE_PREFIX_PATH: /opt/homebrew/opt/ncnn:/opt/homebrew/opt/opencv@4:/opt/homebrew/opt/libomp
+          OpenCV_DIR: /opt/homebrew/opt/opencv@4/lib/cmake/opencv4
+        run: |
+          python -m pip install --upgrade pip build "scikit-build-core>=0.10" "pybind11>=2.11"
+          python -m build --wheel
+
+      - name: Smoke test wheel
+        run: |
+          pip install dist/*.whl opencv-python-headless huggingface-hub pillow pytest
+          python -c "from ncnn_ocr import OCR, NATIVE_AVAILABLE; assert NATIVE_AVAILABLE"
+          python -m pytest -q tests/test_integration.py
+
+      - uses: actions/upload-artifact@v4
+        with:
+          name: wheel-macos-arm64
+          path: dist/*.whl
+
+  build-sdist:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Set version from tag
+        run: bash .github/scripts/set_version_from_tag.sh
+
+      - uses: actions/setup-python@v5
+        with:
+          python-version: "3.12"
+
+      - name: Build sdist
+        run: |
+          python -m pip install --upgrade pip build "scikit-build-core>=0.10" "pybind11>=2.11"
+          python -m build --sdist
+
+      - uses: actions/upload-artifact@v4
+        with:
+          name: sdist
+          path: dist/*.tar.gz
+
+  publish-pypi:
+    name: Publish to PyPI
+    if: startsWith(github.ref, 'refs/tags/v')
+    needs: [test, build-linux, build-macos, build-sdist]
+    runs-on: ubuntu-latest
+    environment:
+      name: pypi
+      url: https://pypi.org/project/ncnn-ocr/
+    steps:
+      - name: Download artifacts
+        uses: actions/download-artifact@v4
+        with:
+          path: dist
+          merge-multiple: true
+
+      - name: List distributions
+        run: ls -lh dist/
+
+      - name: Publish to PyPI
+        uses: pypa/gh-action-pypi-publish@release/v1
+        with:
+          packages-dir: dist
+          print-hash: true
+          password: ${{ secrets.PYPI_API_TOKEN }}

ncnn_ocr-0.1.0/.gitignore

@@ -0,0 +1,33 @@
+# Byte-compiled / cache
+__pycache__/
+*.py[cod]
+*.so
+*.dylib
+*.pyd
+
+# Build artifacts
+build/
+dist/
+*.egg-info/
+.scikit-build/
+cmake-build-*/
+
+# Virtual environments
+.venv/
+venv/
+
+# IDE / OS
+.DS_Store
+.idea/
+.vscode/
+
+# Test / coverage
+.pytest_cache/
+.coverage
+htmlcov/
+
+# Downloaded models (local dev)
+.models/
+
+# Editor swap
+*.swp

ncnn_ocr-0.1.0/CMakeLists.txt

@@ -0,0 +1,83 @@
+cmake_minimum_required(VERSION 3.20)
+project(ncnn_ocr LANGUAGES CXX)
+
+set(CMAKE_CXX_STANDARD 17)
+set(CMAKE_CXX_STANDARD_REQUIRED ON)
+
+if(NOT CMAKE_BUILD_TYPE)
+    set(CMAKE_BUILD_TYPE Release CACHE STRING "Build type" FORCE)
+endif()
+
+if(MSVC)
+    add_compile_options(/W4 /utf-8)
+else()
+    add_compile_options(-Wall -Wextra -Wpedantic)
+endif()
+
+find_package(Python REQUIRED COMPONENTS Interpreter Development.Module)
+find_package(pybind11 CONFIG REQUIRED)
+find_package(OpenCV REQUIRED)
+
+if(APPLE)
+    if(EXISTS "/opt/homebrew/opt/libomp/lib/libomp.dylib")
+        set(OpenMP_CXX_FLAGS "-Xpreprocessor -fopenmp -I/opt/homebrew/opt/libomp/include")
+        set(OpenMP_CXX_LIB_NAMES "omp")
+        set(OpenMP_omp_LIBRARY "/opt/homebrew/opt/libomp/lib/libomp.dylib")
+    elseif(EXISTS "/usr/local/opt/libomp/lib/libomp.dylib")
+        set(OpenMP_CXX_FLAGS "-Xpreprocessor -fopenmp -I/usr/local/opt/libomp/include")
+        set(OpenMP_CXX_LIB_NAMES "omp")
+        set(OpenMP_omp_LIBRARY "/usr/local/opt/libomp/lib/libomp.dylib")
+    endif()
+endif()
+find_package(OpenMP REQUIRED)
+
+if(DEFINED ENV{NCNN_DIR} AND NOT ncnn_DIR)
+    set(ncnn_DIR "$ENV{NCNN_DIR}/lib/cmake/ncnn")
+endif()
+if(NOT ncnn_DIR)
+    foreach(_hint
+        "$ENV{NCNN_DIR}/lib/cmake/ncnn"
+        "$ENV{HOME}/.local/ncnn/lib/cmake/ncnn"
+        "/opt/homebrew/opt/ncnn/lib/cmake/ncnn"
+        "/usr/local/opt/ncnn/lib/cmake/ncnn"
+        "/usr/local/lib/cmake/ncnn")
+        if(EXISTS "${_hint}/ncnnConfig.cmake")
+            set(ncnn_DIR "${_hint}")
+            break()
+        endif()
+    endforeach()
+endif()
+find_package(ncnn REQUIRED)
+
+set(PADDLEOCR_DIR "${CMAKE_CURRENT_SOURCE_DIR}/native/paddleocr")
+
+set(NCNN_OCR_SOURCES
+    native/bindings.cpp
+    ${PADDLEOCR_DIR}/db_net.cpp
+    ${PADDLEOCR_DIR}/angle_net.cpp
+    ${PADDLEOCR_DIR}/crnn_net.cpp
+    ${PADDLEOCR_DIR}/ocr_engine.cpp
+    ${PADDLEOCR_DIR}/utils.cpp
+    ${PADDLEOCR_DIR}/3rdparty/clipper2/clipper.engine.cpp
+    ${PADDLEOCR_DIR}/3rdparty/clipper2/clipper.offset.cpp
+    ${PADDLEOCR_DIR}/3rdparty/clipper2/clipper.rectclip.cpp
+)
+
+pybind11_add_module(_ncnn_ocr MODULE ${NCNN_OCR_SOURCES})
+
+target_include_directories(_ncnn_ocr PRIVATE
+    ${PADDLEOCR_DIR}
+    ${PADDLEOCR_DIR}/3rdparty
+)
+
+target_link_libraries(_ncnn_ocr PRIVATE
+    ${OpenCV_LIBS}
+    ncnn
+    OpenMP::OpenMP_CXX
+)
+
+if(WIN32)
+    target_compile_definitions(_ncnn_ocr PRIVATE NOMINMAX)
+endif()
+
+install(TARGETS _ncnn_ocr DESTINATION ncnn_ocr)

ncnn_ocr-0.1.0/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025 Avafly
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

ncnn_ocr-0.1.0/PKG-INFO

@@ -0,0 +1,197 @@
+Metadata-Version: 2.2
+Name: ncnn-ocr
+Version: 0.1.0
+Summary: High-performance OCR using PaddleOCR PP-OCR Mobile models on Tencent NCNN
+Keywords: ocr,ncnn,paddleocr,pp-ocr,text-recognition
+Author: Abu
+License: Apache-2.0
+Classifier: Development Status :: 4 - Beta
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: Apache Software License
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3 :: Only
+Classifier: Topic :: Scientific/Engineering :: Image Recognition
+Project-URL: Homepage, https://github.com/developerabu/py-ocr-ncnn
+Project-URL: Repository, https://github.com/developerabu/py-ocr-ncnn
+Project-URL: Documentation, https://github.com/developerabu/py-ocr-ncnn#readme
+Requires-Python: >=3.10
+Requires-Dist: numpy>=1.21
+Requires-Dist: opencv-python-headless>=4.5
+Requires-Dist: huggingface-hub>=0.20
+Requires-Dist: pillow>=9.0
+Provides-Extra: dev
+Requires-Dist: pytest>=7; extra == "dev"
+Requires-Dist: ruff>=0.4; extra == "dev"
+Description-Content-Type: text/markdown
+
+# ncnn-ocr
+
+Production-ready Python OCR built on [PaddleOCR PP-OCR Mobile](https://github.com/PaddlePaddle/PaddleOCR) models running on [Tencent NCNN](https://github.com/Tencent/ncnn).
+
+Standalone, publishable to PyPI, and independent of Qefro.
+
+## Features
+
+- **Fast CPU inference** — NCNN-backed det + cls + rec pipeline (same engine as [PaddleOCR-ncnn-CPP](https://github.com/Avafly/PaddleOCR-ncnn-CPP))
+- **PP-OCRv5 multilingual** — Tamil, Arabic, Devanagari, Latin, Korean, Cyrillic, and more
+- **PP-OCRv6 profiles** — `v6_tiny`, `v6_small`, `v6_medium`
+- **Simple API** — `recognize()`, `recognize_text()`, `batch()`
+- **Auto model download** — pulls weights from [developerabu/pp-OCRv5-6-ncnn](https://huggingface.co/developerabu/pp-OCRv5-6-ncnn) on first use
+- **Arabic post-processing** — optional visual-order → logical-order fix
+
+## Install
+
+### From source (requires native deps)
+
+```bash
+# macOS (Homebrew)
+brew install cmake opencv ncnn
+
+# Debian/Ubuntu
+sudo apt install cmake libopencv-dev libomp-dev
+
+# Build ncnn if not packaged (see https://github.com/Tencent/ncnn)
+export NCNN_DIR=$HOME/.local/ncnn   # optional, CMake searches common paths
+
+pip install .
+```
+
+### Python dependencies only (no extension)
+
+Pure-Python modules import without the `_ncnn_ocr` extension; `OCR()` raises a clear error until the native module is built.
+
+## Quick start
+
+```python
+from ncnn_ocr import OCR
+
+ocr = OCR(lang="ta")
+text = ocr.recognize_text("page.png")
+print(text)
+
+lines = ocr.recognize("page.png")
+for line in lines:
+    print(line.text, line.confidence, line.box)
+```
+
+One-shot helpers:
+
+```python
+from ncnn_ocr import recognize_text
+
+print(recognize_text("scan.jpg", lang="en"))
+```
+
+## Supported languages (PP-OCRv5)
+
+| Code | Script / language |
+|------|---------------------|
+| `en` | English |
+| `ta`, `te` | Tamil, Telugu |
+| `hi`, `mr`, `ne` | Devanagari |
+| `ar`, `fa`, `ur` | Arabic |
+| `ko`, `th`, `el` | Korean, Thai, Greek |
+| `ru`, `uk`, `bg` | Cyrillic / Slavic |
+| `de`, `fr`, `es`, `latin` | Latin |
+| `ch`, `zh` | Chinese (generic v5 rec) |
+
+```python
+from ncnn_ocr import supported_langs
+print(supported_langs())
+```
+
+## PP-OCRv6
+
+```python
+ocr = OCR(lang="en", profile="v6_tiny")
+text = ocr.recognize_text("page.png")
+```
+
+Profiles: `v6_tiny`, `v6_small`, `v6_medium`.
+
+## Environment variables
+
+| Variable | Default | Description |
+|----------|---------|-------------|
+| `NCNN_OCR_MODEL_DIR` | `~/.cache/ncnn-ocr/models` | Local model cache |
+| `NCNN_OCR_HF_REPO` | `developerabu/pp-OCRv5-6-ncnn` | HuggingFace model repo |
+
+## Build layout
+
+```
+py-ocr-ncnn/
+├── src/ncnn_ocr/       # Python package
+├── native/
+│   ├── bindings.cpp    # pybind11 wrapper
+│   └── paddleocr/      # vendored NCNN OCR engine (Apache-2.0)
+├── CMakeLists.txt
+└── pyproject.toml
+```
+
+## Models
+
+On first run, recognition models and keys are downloaded from HuggingFace. Shared PP-OCRv5 detection and angle-classifier weights are fetched from HuggingFace when available, otherwise from the [PaddleOCR-ncnn-CPP v0.3.0 archive](https://github.com/Avafly/PaddleOCR-ncnn-CPP/releases/download/v0.3.0/archive.tar.gz).
+
+## Development
+
+```bash
+python -m venv .venv && source .venv/bin/activate
+pip install -e ".[dev]"
+PYTHONPATH=src pytest -q
+```
+
+## Release to PyPI
+
+| Event | Workflow | What happens |
+|-------|----------|--------------|
+| Push to `main` / PR | `ci.yml` | Tests + builds wheels (artifacts only, **no PyPI**) |
+| Push tag `v*` | `release.yml` | Tests + builds wheels + **publishes to PyPI** |
+
+Pushing a version tag triggers `.github/workflows/release.yml`, which:
+
+1. Runs unit tests
+2. Builds Linux (`x86_64`) and macOS (`arm64`) wheels plus an sdist
+3. Runs an integration OCR smoke test on each wheel
+4. Publishes all artifacts to PyPI
+
+### One-time PyPI setup
+
+1. Create a PyPI API token at [pypi.org/manage/account/token](https://pypi.org/manage/account/token/) scoped to `ncnn-ocr`
+2. Add it as a GitHub secret:
+   - Go to [github.com/qefro-ai/py-ocr-ncnn/settings/secrets/actions](https://github.com/qefro-ai/py-ocr-ncnn/settings/secrets/actions)
+   - **New repository secret**
+   - Name: **`PYPI_API_TOKEN`**
+   - Value: your `pypi-...` token
+3. Create GitHub environment **`pypi`** (Settings → Environments) — used by the release workflow
+
+### Cut a release
+
+```bash
+git tag v0.1.0
+git push origin v0.1.0
+```
+
+The workflow reads the tag (`v0.1.0` → version `0.1.0`) and uploads:
+
+- `ncnn_ocr-*-cp312-cp312-linux_x86_64.whl`
+- `ncnn_ocr-*-cp312-cp312-macosx_*_arm64.whl`
+- `ncnn_ocr-*.tar.gz`
+
+### Manual publish (fallback)
+
+```bash
+bash scripts/build_wheel.sh
+python -m twine upload dist/*
+```
+
+Requires `TWINE_USERNAME=__token__` and `TWINE_PASSWORD` set to a PyPI API token.
+
+## License
+
+Apache-2.0 — see [LICENSE](LICENSE). The vendored PaddleOCR-ncnn-CPP sources retain their original license.
+
+## Credits
+
+- [Avafly/PaddleOCR-ncnn-CPP](https://github.com/Avafly/PaddleOCR-ncnn-CPP) — NCNN OCR engine
+- [PaddleOCR](https://github.com/PaddlePaddle/PaddleOCR) — PP-OCR models
+- [Tencent NCNN](https://github.com/Tencent/ncnn) — inference framework