Metadata-Version: 2.1
Name: hycli
Version: 0.6.0
Summary: Hypatos cli tool to batch extract documents through the API and to compare the results.
Home-page: https://hypatos.ai
Keywords: hypatos,document,etraction,ocr
Author: Dylan Bartels
Author-email: dylan.bartels@hypatos.ai
Requires-Python: >=3.7,<4.0
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
Requires-Dist: Jinja2 (>=2.11.2,<3.0.0)
Requires-Dist: Pillow (>=8.1.0,<9.0.0)
Requires-Dist: XlsxWriter (>=1.2.7,<2.0.0)
Requires-Dist: click (>=7.0,<8.0)
Requires-Dist: click-log (>=0.3.2,<0.4.0)
Requires-Dist: filetype (>=1.0.5,<2.0.0)
Requires-Dist: fpdf (>=1.7.2,<2.0.0)
Requires-Dist: halo (>=0.0.29,<0.0.32)
Requires-Dist: openpyxl (>=3.0.5,<4.0.0)
Requires-Dist: pandas (>=1.0.5,<2.0.0)
Requires-Dist: pdf2image (>=1.14.0,<2.0.0)
Requires-Dist: requests (>=2.22.0,<3.0.0)
Requires-Dist: seaborn (>=0.11.1,<0.12.0)
Requires-Dist: sqlalchemy (>=1.3.22,<2.0.0)
Requires-Dist: xlrd (>=1.2.0,<2.0.0)
Project-URL: Documentation, https://hypatos.github.io/hycli/
Description-Content-Type: text/markdown

# Hycli

[![PyPI - Python Version](https://img.shields.io/pypi/pyversions/hycli)](https://pypi.org/project/hycli/)
[![PyPI version](https://badge.fury.io/py/hycli.svg)](https://pypi.org/project/hycli/)
[![Code style: black](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/psf/black)
![Main workflow](https://github.com/hypatos/hycli/workflows/Main%20workflow/badge.svg)

This repository contains a Python package/CLI tool to batch extract documents through the Hypatos API and to compare the results.

## Quickstart

```
pip install hycli
hycli extract path-to-files [to-xlsx|to-csv|to-json] url
hycli compare workbook1 workbook2
hycli evaluate -gt ground-truth-workbook -m1 model1-workbook -m2 model2-workbook
```

For more information without leaving the cli use ```hycli --help```

## API Reference and User Guide [available](https://hypatos.github.io/hycli/)


---

## Development

### Requirement

- [poetry](https://python-poetry.org/)

### Installing

```
poetry install
poetry shell
hycli --help
```

### Running the tests

```
poetry run pytest
```

### Versioning

Uses [bump2version](https://github.com/c4urself/bump2version):

```
bump2version --verbose [patch|minor|major]  # add --dry-run to have a preview
git push --follow-tags
```

### Documentation

Is build with sphinx, can be seen/worked on locally by:

```
cd docs
make html
open build/html/index.html
```

### License

Hypatos

