Skip to main content

openbharatocr is an opensource python library for ocr Indian government documents

Project description

openbharatocr

Build status

openbharatocr is a Python library developed as open-source, designed specifically for optical character recognition (OCR) of Indian government documents.

The features of this package:

  • It offers comprehensive support for the majority of Indian government documents, covering a wide range of document types.

Installation

    pip install openbharatocr

Pan Card

This function takes the path of a PAN card image as input and returns its information in the form of a dictionary.

    import openbharatocr 
    dict_output = openbharatocr.pan(image_path)

Aadhaar Card

The two functions accepts the file paths of the front and back images of an Aadhaar card as input and returns their corresponding information encapsulated in a dictionary.

    import openbharatocr 
    dict_output = openbharatocr.front_aadhaar(image_path)
    dict_output = openbharatocr.back_aadhaar(image_path)

Driving Licence

This function takes the path of a Driving Licence card image as input and returns its information in the form of a dictionary.

    import openbharatocr 
    dict_output = openbharatocr.driving_licence(image_path)

Passport

This function takes the path of a Passport image as input and returns its information in the form of a dictionary.

    import openbharatocr 
    dict_output = openbharatocr.passport(image_path)

VoterID

The two functions accepts the file paths of the front and back images of a voterID as input and returns their corresponding information encapsulated in a dictionary.

    import openbharatocr 
    # Download YOLOv3 models from links(added below) and set local downloaded path to YOLO_CFG, YOLO_WEIGHT env variables
    dict_output = openbharatocr.voter_id_front(image_path)
    dict_output = openbharatocr.voter_id_back(image_path)

Download Resources

Some resources need to be downloaded and set the path in the variables.

Vehicle Registration Card/Certificate

This function takes the path of a Vehicle Registration Card/Certificate image as an input and returns its information in the form of a dictionary.

    import openbharatocr 
    dict_output = openbharatocr.vehicle_registration(image_path)

Water Bill

This function takes the path of a Water Bill image as an input and returns its information in the form of a dictionary.

    import openbharatocr 
    dict_output = openbharatocr.water_bill(image_path)

Birth Certificate

This function takes the path of a Birth Certificate image as an input and returns its information in the form of a dictionary.

    import openbharatocr 
    dict_output = openbharatocr.birth_certificate(image_path)

Contribute & support

We are so pleased to your help and help you. If you wanna develop openbharatocr, Congrats! If you have problem, don't worry, create an issue here:

    https://github.com/essentiasoftserv/openbharatocr/issues

Pre Commit

Note: Before committing your changes, run pre-commits

    pre-commit run --all

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

openbharatocr-0.4.0b0.tar.gz (23.8 kB view details)

Uploaded Source

Built Distribution

openbharatocr-0.4.0b0-py3-none-any.whl (30.3 kB view details)

Uploaded Python 3

File details

Details for the file openbharatocr-0.4.0b0.tar.gz.

File metadata

  • Download URL: openbharatocr-0.4.0b0.tar.gz
  • Upload date:
  • Size: 23.8 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.1.0 CPython/3.9.19

File hashes

Hashes for openbharatocr-0.4.0b0.tar.gz
Algorithm Hash digest
SHA256 6e22d9d33acabc3883065dd7ebba18b3a9b4cb2c06819aef30965a8e7d03e6a8
MD5 c26b5fbc1faa84a78465155a1b667a3e
BLAKE2b-256 bed35d92b8c674534edc78c6e6b215ef7255b877afb497f8a7e42e585d81533b

See more details on using hashes here.

File details

Details for the file openbharatocr-0.4.0b0-py3-none-any.whl.

File metadata

File hashes

Hashes for openbharatocr-0.4.0b0-py3-none-any.whl
Algorithm Hash digest
SHA256 8604db07eb989225b6f9ab7f9bdb87d979a32f81cbf90b371493bbdb749dd7b4
MD5 7a90f7216c8ce678870076ac29545360
BLAKE2b-256 935a93a065230a195d0553d70fd258a3fd7729fb989211edd91514ef012473f4

See more details on using hashes here.

Supported by

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