Metadata-Version: 2.1
Name: bharatocr-client
Version: 0.4
Summary: bharatocr-client is an opensource python library to access BharatOcrAPIs 
Home-page: https://github.com/essentiasoftserv/bharatocrclient
Author: essentiasoftserv
Author-email: kunal@essentia.dev
License: Apache
Requires-Python: >=3.6
Description-Content-Type: text/markdown
License-File: LICENSE

# bharatocr-client
[![Build status](https://github.com/essentiasoftserv/bharatocrclient/actions/workflows/main.yml/badge.svg)](https://github.com/essentiasoftserv/bharatocrclient/actions/workflows/main.yml)

bharatocr-client is an opensource python library to access BharatOcrAPIs

The features of this package:
- Its a package that help to access BharatOcrAPIs in simple way.  


#### Installation


```
    pip install bharatocr-client
```


**Register**

In this function, User can register in the application to use the BharatOcrAPIs.

```
    import bharatocrclient 
    status = bharatocrclient.register(email,password,full_name,use_type)
    # use_type -> must be personal, commercial
```


**Login**

In this function, User must be login in the application before use featured function of the application.

```
    import bharatocrclient 
    key, status = bharatocrclient.login(email, password)
```

**Pan Card**

In this function, User pass the generated key after login and Pan Card image path.

```
    import bharatocrclient 
    dict = bharatocrclient.pan(key, image)
```
**Aadhaar Card**

In this function, User pass the generated key after login and Aadhaar Card image path.

```
    import bharatocrclient as b
    dict = b.aadhaar(key, front_image, back_image)
```

**Driving Licence**

In this function, User pass the generated key after login and Driving Licence image path.

```
    import bharatocrclient as b
    dict = b.driving_licence(key, image)
```

**Passport**

In this function, User pass the generated key after login and Passport Card image path.

```
    import bharatocrclient as b
    dict = b.passport(key, image)
```

**Voter ID**

In this function, User pass the generated key after login and voter id Card image path.

```
    import bharatocrclient as b
    dict = b.voterid(key, front_image, back_image)
```

**Vehicle Registration**

In this function, User pass the generated key after login and Vehicle Registration Card image path.

```
    import bharatocrclient as b
    dict = b.vehicle_registration(key, image)
```

**Water Bill**

In this function, User pass the generated key after login and Water Bill image path.

```
    import bharatocrclient as b
    dict = b.water_bill(key, image)
```

### Contribute & support
We are so pleased to your help and help you, If you wanna develop bharatocrclient, Congrats or if you have problem, don't worry create an issue here:

```
    https://github.com/essentiasoftserv/bharatocrclient/issues
```

### Pre Commit
Note: Before commit your changes, run pre-commits 

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