OpenBharatOCR

https://pypi.org/project/openbharatocr/
Admin
OpenBharatOCR is an open-source Python library designed for optical character recognition (OCR) of...
Tokens:2,125
Snippets:39
Trust Score:10
Update:3 months ago
Show doc for...
Tokens:
Raw
### Install Package

Source: https://pypi.org/project/openbharatocr/0.4.3

Install the openbharatocr library via pip.

```bash
    pip install openbharatocr
```

--------------------------------

### Install Dependencies

Source: https://pypi.org/project/openbharatocr/0.4.3

Install required packages from the requirements file.

```bash
    cd openbharatocr
    pip install -r requirements.txt
```

--------------------------------

### Activate Virtual Environment

Source: https://pypi.org/project/openbharatocr/0.4.3

Activate the created virtual environment.

```bash
source openbharatocr_env/bin/activate  # For venv
# OR
source openbharatocr_env/bin/activate  # For virtualenv
```

--------------------------------

### Create Virtual Environment

Source: https://pypi.org/project/openbharatocr/0.4.3

Isolate project dependencies using venv or virtualenv.

```bash
    python3 -m venv openbharatocr_env  # Using venv
    # OR
    virtualenv openbharatocr_env      # Using virtualenv
```

--------------------------------

### Run Pre-commit Hooks

Source: https://pypi.org/project/openbharatocr/0.4.3

Execute pre-commit hooks before committing changes.

```bash
    pre-commit run --all
```

--------------------------------

### Report Issues

Source: https://pypi.org/project/openbharatocr/0.4.3

Link to the GitHub issues page for support.

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

--------------------------------

### Clone Repository

Source: https://pypi.org/project/openbharatocr/0.4.3

Clone the openbharatocr repository from GitHub.

```bash
git clone https://github.com/essentiasoftserv/openbharatocr.git
```

--------------------------------

### openbharatocr.water_bill(image_path)

Source: https://pypi.org/project/openbharatocr/0.4.3

Extracts information from a Water Bill image.

```APIDOC
## openbharatocr.water_bill(image_path)

### Description
Takes the path of a Water Bill image as an input and returns its information in the form of a dictionary.

### Parameters
- **image_path** (string) - Required - The file path to the Water Bill image.
```

--------------------------------

### openbharatocr.pan(image_path)

Source: https://pypi.org/project/openbharatocr/0.4.3

Extracts information from a PAN card image.

```APIDOC
## openbharatocr.pan(image_path)

### Description
Takes the path of a PAN card image as input and returns its information in the form of a dictionary.

### Parameters
- **image_path** (string) - Required - The file path to the PAN card image.
```

--------------------------------

### Extract Water Bill Information

Source: https://pypi.org/project/openbharatocr/0.4.3

Extract information from a Water Bill image.

```python
    import openbharatocr 
    dict_output = openbharatocr.water_bill(image_path)
```

--------------------------------

### openbharatocr.front_aadhaar(image_path) / openbharatocr.back_aadhaar(image_path)

Source: https://pypi.org/project/openbharatocr/0.4.3

Extracts information from the front or back of an Aadhaar card.

```APIDOC
## openbharatocr.front_aadhaar(image_path) / openbharatocr.back_aadhaar(image_path)

### Description
Accepts the file path of the front or back image of an Aadhaar card as input and returns the information encapsulated in a dictionary.

### Parameters
- **image_path** (string) - Required - The file path to the Aadhaar card image.
```

--------------------------------

### openbharatocr.degree(image_path)

Source: https://pypi.org/project/openbharatocr/0.4.3

Extracts information from a Degree image.

```APIDOC
## openbharatocr.degree(image_path)

### Description
Takes the path of a Degree image as an input and returns its information in the form of a dictionary.

### Parameters
- **image_path** (string) - Required - The file path to the Degree image.
```

--------------------------------

### openbharatocr.driving_licence(image_path)

Source: https://pypi.org/project/openbharatocr/0.4.3

Extracts information from a Driving Licence image.

```APIDOC
## openbharatocr.driving_licence(image_path)

### Description
Takes the path of a Driving Licence card image as input and returns its information in the form of a dictionary.

### Parameters
- **image_path** (string) - Required - The file path to the Driving Licence image.
```

--------------------------------

### openbharatocr.vehicle_registration(image_path)

Source: https://pypi.org/project/openbharatocr/0.4.3

Extracts information from a Vehicle Registration Card/Certificate image.

```APIDOC
## openbharatocr.vehicle_registration(image_path)

### Description
Takes the path of a Vehicle Registration Card/Certificate image as an input and returns its information in the form of a dictionary.

### Parameters
- **image_path** (string) - Required - The file path to the Vehicle Registration image.
```

--------------------------------

### openbharatocr.passport(image_path)

Source: https://pypi.org/project/openbharatocr/0.4.3

Extracts information from a Passport image.

```APIDOC
## openbharatocr.passport(image_path)

### Description
Takes the path of a Passport image as input and returns its information in the form of a dictionary.

### Parameters
- **image_path** (string) - Required - The file path to the Passport image.
```

--------------------------------

### openbharatocr.birth_certificate(image_path)

Source: https://pypi.org/project/openbharatocr/0.4.3

Extracts information from a Birth Certificate image.

```APIDOC
## openbharatocr.birth_certificate(image_path)

### Description
Takes the path of a Birth Certificate image as an input and returns its information in the form of a dictionary.

### Parameters
- **image_path** (string) - Required - The file path to the Birth Certificate image.
```

--------------------------------

### openbharatocr.voter_id_front(image_path) / openbharatocr.voter_id_back(image_path)

Source: https://pypi.org/project/openbharatocr/0.4.3

Extracts information from the front or back of a VoterID.

```APIDOC
## openbharatocr.voter_id_front(image_path) / openbharatocr.voter_id_back(image_path)

### Description
Accepts the file path of the front or back image of a VoterID as input and returns the information encapsulated in a dictionary. Note: Requires YOLO_CFG and YOLO_WEIGHT environment variables to be set.

### Parameters
- **image_path** (string) - Required - The file path to the VoterID image.
```

--------------------------------

### Extract Vehicle Registration Information

Source: https://pypi.org/project/openbharatocr/0.4.3

Extract information from a Vehicle Registration Card/Certificate image.

```python
    import openbharatocr 
    dict_output = openbharatocr.vehicle_registration(image_path)
```

--------------------------------

### Extract Birth Certificate Information

Source: https://pypi.org/project/openbharatocr/0.4.3

Extract information from a Birth Certificate image.

```python
    import openbharatocr 
    dict_output = openbharatocr.birth_certificate(image_path)
```

--------------------------------

### Extract Driving Licence Information

Source: https://pypi.org/project/openbharatocr/0.4.3

Extract information from a Driving Licence image.

```python
    import openbharatocr 
    dict_output = openbharatocr.driving_licence(image_path)
```

--------------------------------

### Extract PAN Card Information

Source: https://pypi.org/project/openbharatocr/0.4.3

Extract information from a PAN card image.

```python
    import openbharatocr 
    dict_output = openbharatocr.pan(image_path)
```

--------------------------------

### Extract Passport Information

Source: https://pypi.org/project/openbharatocr/0.4.3

Extract information from a Passport image.

```python
    import openbharatocr 
    dict_output = openbharatocr.passport(image_path)
```

--------------------------------

### Extract Degree Information

Source: https://pypi.org/project/openbharatocr/0.4.3

Extract information from a Degree image.

```python
    import openbharatocr 
    dict_output = openbharatocr.degree(image_path)
```

--------------------------------

### Extract VoterID Information

Source: https://pypi.org/project/openbharatocr/0.4.3

Extract information from front and back images of a VoterID. Requires YOLOv3 models to be configured.

```python
    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)
```

--------------------------------

### Extract Aadhaar Card Information

Source: https://pypi.org/project/openbharatocr/0.4.3

Extract information from front and back images of an Aadhaar card.

```python
    import openbharatocr 
    dict_output = openbharatocr.front_aadhaar(image_path)
    dict_output = openbharatocr.back_aadhaar(image_path)
```
Tokens:
Raw