OCR CITIZENSHIP

Extract valuable entities from just the photo of the citizenship card.

Table of Contents

1. About The Project
   • Built With
2. Getting Started
   • Prerequisites
   • Installation
3. Usage
4. Contact
5. Acknowledgments

About The Project

The OCR Citizenship is a powerful software program designed to streamline the extraction of valuable entities from citizenship images. Leveraging advanced image processing techniques, Optical Character Recognition (OCR), and Natural Language Processing (NLP) algorithms, this project automates the process of extracting essential information from citizenship documents, reducing manual effort and enhancing efficiency. The user interface and front-end of the system are built using Streamlit, providing a seamless and interactive experience for users.

(back to top)

Built With

• Python
• Tensorflow
• Tesseract/ PyTesseract
• Streamlit
• OpenCV
• Numpy
• Docker
• Google OCR

(back to top)

Getting Started

To get a local copy up and running follow these simple steps.

1. Clone the repo

   git clone git@github.com:sushilld/ocr_citizenship.git

2. Install Docker

   https://docs.docker.com/engine/install/

3. Install Docker Compose

   https://docs.docker.com/compose/install/

4. Build Docker Image

   docker build -t ocr_citizenship .

5. Run Docker Container

   docker run -it -p 8501:8501 -e ip_address="127.0.0.1" -e ip_port="6011" -e show_google="true" sushil3125/ocr_citizenship
   

6. Login using test as username and test as password

7. Upload both of the images of the citizenship (Front and Back)

8. Click on Submit button and you will see a preview of your citienship card.

9. Navigate to specific tab to see the extracted entities from the image.

Prerequisites

Following are the prerequisites for this project.

• Docker

    https://docs.docker.com/engine/install/

• Docker Compose

      https://docs.docker.com/compose/install/

• Python

    https://www.python.org/downloads/

Installation

1. Clone the repo

   git clone git@github.com:sushilld/ocr_citizenship.git

2. Install Docker

   https://docs.docker.com/engine/install/

3. Install Docker Compose

   https://docs.docker.com/compose/install/

4. Build Docker Image

   docker build -t ocr_citizenship .

5. Run Docker Container

   docker run -it -p 8501:8501 -e ip_address="127.0.0.1" -e ip_port="6011" -e show_google="true" sushil3125/ocr_citizenship

(back to top)

Usage

This project is designed to extract valuable entities from citizenship images. The user interface and front-end of the system are built using Streamlit, providing a seamless and interactive experience for users. The user can upload the image of the citizenship card and the system will extract the following entities from the image.

(back to top)

Contact

Sushil Dhakal - LinkedIn - sushilldhakal25@gmail.com

Project Link: https://github.com/sushilld/ocr_citizenship.git

(back to top)

Acknowledgments

Thanks to the following resources for helping me build this project.

• [![Streamlit][Streamlit.io]][Streamlit-url]
• [![Tensorflow][Tensorflow.org]][Tensorflow-url]
• [![PyTesseract][PyTesseract.org]][PyTesseract-url]
• [![OpenCV][OpenCV.org]][OpenCV-url]
• [![Numpy][Numpy.org]][Numpy-url]
• and many more...

(back to top)