Metadata-Version: 2.1
Name: Aadhaar-extractor
Version: 0.0.5
Summary: Detects and extracts the features in a aadhaar card
Home-page: https://github.com/Akash-k-p/Aadhaar_Extractor.git
Author: Akash K P
Author-email: kpakash03@gmail.com
Classifier: Programming Language :: Python :: 3
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Requires-Python: >3.8
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: numpy
Requires-Dist: ultralytics
Requires-Dist: opencv-python
Requires-Dist: pytesseract

# Use to extract details from a image of a aadhaar card

 Trained using YOLOv8

 [Dataset](https://universe.roboflow.com/akash-k-p-gs9iu/aadhaar-card-details-extraction-3/dataset/7)

Check out the Github [Repo](https://github.com/Akash-k-p/Aadhaar_Extractor/) for more info



> Note : Requires external installation of tesseract , and setting the environment variable of the same


## How to use :

```
from Aadhaar_extractor.Extractor import AadhaarExtractor

#create a object of the AadhaarExtractor class by passing the image of the aadhaar card as argument


obj = AadhaarExtractor("aadhaar.jpg")

#use obj.extract() for extracting the data 

extractedData = obj.extract()

```


The extract() method will return , a list of all the fields detected .

This module currently detects five fields:

1. Aadhaar Number (aadhaar_no)
2. Date of Birth (dob)
3. Gender (gender)
4. Name (name)
5. Address (address)

Each field is member of the list(detected field), has four fields in the following order

1. The coordinates of the detected field in x1,y1,x2,y2 format (type=list)

2. The name of the field

3. Confidence of detection 

4. Extracted text from the detected field

**Note:All the data used to train , were publicly available in the internet**

***This project is far from complete, and can be made much better, feel free to contribute***
