Metadata-Version: 2.1
Name: idcard-detector
Version: 0.1.0
Summary: Package providing functionality to detect any id card from image and crop it.
Home-page: https://gitlab.backbone.sk/kpay/idcard-detector
Author: Backbone s.r.o.
Author-email: office@backbone.sk
License: MIT
Platform: UNKNOWN
Classifier: Development Status :: 4 - Beta
Classifier: Environment :: Console
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: Implementation :: PyPy
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: MIT License
Classifier: Topic :: Scientific/Engineering :: Image Processing
Classifier: Topic :: Scientific/Engineering :: Image Recognition
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: Pillow (==8.3.*)
Requires-Dist: tensorflow (==2.5.*)
Requires-Dist: numpy (==1.19.5)
Requires-Dist: opencv-python (==3.4.15.55)
Requires-Dist: matplotlib (==3.4.*)
Requires-Dist: object-detection-0.1 (==0.1)

# idcard-detector

Package providing functionality to detect any id card from image and crop it.

## Installation

```shell
# pip
pip install idcard-detector

# pipenv
pipenv install idcard-detector

# poetry
poetry add idcard-detector
```

## Example

```python
from idcard_detector.detection import IdCardDetector


with open('path/to/image.jpg', 'rb') as file:
    pil_image = IdCardDetector.detect_card(file_content=file.read())
```

## Tests

To run tests, you need to run command: `pytest`

For security reasons, tests require your own id card images.

---
Developed by [BACKBONE s.r.o.](https://www.backbone.sk/), 2021 (C)

## 0.1.0 : 2021-11-08

- Initial release


