Skip to main content

A Python library for detecting and extracting data from Cambodian National ID cards.

Project description

Khmer NID Detector

Alt text

A Python package for detecting and extracting information from Khmer National ID cards using OCR and computer vision.

Features

  • 🔍 Card Type Detection: Automatically detects various types of cards and documents
  • 🇰🇭 Khmer NID Optimized: Specifically designed for Cambodian National ID cards
  • 📄 Information Extraction: Extracts NID number, name, and date of birth
  • 🖼️ Image Preprocessing: Enhances image quality for better OCR accuracy
  • 🚀 Easy to Use: Simple API with clear documentation

Supported Card Types

  • nid_card - Khmer National ID card
  • credit_card - Credit card
  • debit_card - Debit card
  • driver_license - Driver's license
  • business_card - Business card
  • other_document - Other document types
  • not_a_card - Not a card or document

Installation

pip install khmer-nid-detector

example to use

    # from khmer_nid_detector import detect_card_type, process_nid_card

    from khmer_nid_detector import detect_card_type, process_nid_card

    # Read image as bytes
    with open("nid_card.jpg", "rb") as f:
        image_bytes = f.read()

    # Detect card type
    card_type = detect_card_type(image_bytes)
    print(f"Detected card type: {card_type}")

    # If it's an NID card, process it
    if card_type == "nid_card":
        result = process_nid_card(image_bytes)

        if result["success"]:
            print(f"NID Number: {result['nid_number']}")
            print(f"Name: {result['name']}")
            print(f"Date of Birth: {result['dob']}")
            print(f"Is Khmer NID: {result['is_khmer_nid']}")
            print(f"Message: {result['message']}")
        else:
            print(f"Error: {result['message']}")

example Structure Code

.
├── IMG_20251005_154748.png
├── nid_card.jpg
├── nid_env
│   ├── bin
│   ├── include
│   ├── lib
│   ├── pyvenv.cfg
│   └── share
└── v1.py

Example to run Code

python3 v1.py   

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

khmer_nid_detector-0.1.1.tar.gz (2.3 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

khmer_nid_detector-0.1.1-py3-none-any.whl (2.2 kB view details)

Uploaded Python 3

File details

Details for the file khmer_nid_detector-0.1.1.tar.gz.

File metadata

  • Download URL: khmer_nid_detector-0.1.1.tar.gz
  • Upload date:
  • Size: 2.3 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.11.11

File hashes

Hashes for khmer_nid_detector-0.1.1.tar.gz
Algorithm Hash digest
SHA256 3c24f6fd00d318abbc4ab24773e65ba4f72866b2ed0635b82e1c88d859939145
MD5 aaea53559ab4074bd19f27063bc39b45
BLAKE2b-256 a14fce87bea83782ce564d108c4d3ed1d366c9fb7ffe400ff8002c3c2d54c88d

See more details on using hashes here.

File details

Details for the file khmer_nid_detector-0.1.1-py3-none-any.whl.

File metadata

File hashes

Hashes for khmer_nid_detector-0.1.1-py3-none-any.whl
Algorithm Hash digest
SHA256 92343e93715574ab264c564a2fd9121169542b5bbb94b1fc1d2d15a9bea3c9a5
MD5 056e715cf6699c7b7f4a889982c7a1f4
BLAKE2b-256 bdd8d54e50943ecd30ddf19720955c7aa3b1dc60f0419220f5f0250e11d2c8df

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page