PassportEye 开源项目教程

PassportEye 开源项目教程

PassportEyeExtraction of machine-readable zone information from passports, visas and id-cards via OCR项目地址:https://gitcode.com/gh_mirrors/pa/PassportEye

1. 项目的目录结构及介绍

PassportEye 项目的目录结构如下：

PassportEye/
├── passporteye/
│   ├── __init__.py
│   ├── mrz/
│   │   ├── __init__.py
│   │   ├── scripts/
│   │   │   ├── __init__.py
│   │   │   ├── evaluate_mrz.py
│   │   │   ├── mrz.py
│   │   │   ├── extract_mrz_rois.py
│   ├── ...
├── setup.py
├── README.rst
├── requirements.txt
├── ...

目录结构介绍：

• passporteye/: 这是项目的主要代码目录，包含了所有与 PassportEye 相关的 Python 模块和脚本。
  • init.py: 初始化文件，定义了包的版本等信息。
  • mrz/: 包含了与机器可读区（MRZ）处理相关的模块和脚本。
    • scripts/: 包含了用于处理 MRZ 的脚本文件。
      • evaluate_mrz.py: 用于评估 MRZ 的脚本。
      • mrz.py: 用于处理 MRZ 的主要脚本。
      • extract_mrz_rois.py: 用于提取 MRZ 区域的脚本。
• setup.py: 项目的安装配置文件，用于定义项目的依赖和安装方式。
• README.rst: 项目的说明文档，包含了项目的概述、安装方法和使用说明。
• requirements.txt: 项目的依赖文件，列出了项目运行所需的 Python 包。

2. 项目的启动文件介绍

PassportEye 项目的启动文件主要位于 passporteye/mrz/scripts/ 目录下。以下是主要的启动文件及其功能介绍：

• evaluate_mrz.py: 该脚本用于评估 MRZ 的识别效果，通常用于测试和调试。
• mrz.py: 这是处理 MRZ 的主要脚本，包含了识别和解析 MRZ 的核心逻辑。
• extract_mrz_rois.py: 该脚本用于从图像中提取 MRZ 区域，是 MRZ 处理的前置步骤。

3. 项目的配置文件介绍

PassportEye 项目的配置文件主要包括以下几个：

• setup.py: 该文件定义了项目的安装配置，包括项目的名称、版本、依赖包等信息。通过运行 python setup.py install 可以安装项目及其依赖。
• requirements.txt: 该文件列出了项目运行所需的 Python 包及其版本要求。可以通过 pip install -r requirements.txt 来安装所有依赖。

配置文件示例：

setup.py:

from setuptools import setup, find_packages

setup(
    name='PassportEye',
    version=[ln for ln in open("passporteye/__init__.py") if ln.startswith("__version__")][0].split('"')[1],
    description="Extraction of machine-readable zone information from passports visas and id-cards via OCR",
    long_description=open("README.rst").read(),
    classifiers=[
        'Development Status :: 4 - Beta',
        'Programming Language :: Python :: 3 :: Only',
        'Topic :: Scientific/Engineering :: Image Recognition',
        'License :: OSI Approved :: MIT License',
        'Intended Audience :: Developers',
        'Intended Audience :: Science/Research',
        'Intended Audience :: Legal Industry',
        'Intended Audience :: Financial and Insurance Industry'
    ],
    keywords='id-card passport image-processing mrz machine-readable-zone',
    author='Konstantin Tretyakov',
    author_email='kt@ut.ee',
    url='https://github.com/konstantint/PassportEye',
    license='MIT',
    packages=find_packages(exclude=['examples', 'tests']),
    include_package_data=True,
    zip_safe=False,
    install_requires=[
        'numpy',
        'scipy',
        'scikit-image >= 0.19.0',
        'imageio',
        'scikit-learn',
        'matplotlib',
        'pytesseract >= 0.2.0',
        'imageio',
        'pdfminer >= 20191010'
    ],
    extras_require={
        "test": ["pytest"],
        "dev": ["pytest", "pylint", "jupyter", "twine"]
    },
    entry_points={
        'console_scripts': [
            'evaluate_mrz=passporteye.mrz.scripts:evaluate_mrz',
            'mrz=passporteye.mrz.scripts:mrz',
            'extract_mrz_rois=passporteye.mrz.scripts:extract_mrz_rois'
        ]
    }
)

requirements.txt:

numpy
scipy
scikit-image>=0.19.0
imageio
scikit-learn
matplotlib
pytesseract>=0.2.0
pdfminer>=20191010

通过以上配置文件，可以方便地安装和管理 PassportEye 项目的依赖，并启动项目的核心功能。

PassportEyeExtraction of machine-readable zone information from passports, visas and id-cards via OCR项目地址:https://gitcode.com/gh_mirrors/pa/PassportEye