Metadata-Version: 2.1
Name: mindee
Version: 2.5.1
Summary: Mindee API helper library for Python
Home-page: https://mindee.com/
Author: Mindee
Author-email: devrel@mindee.com
License: MIT
Project-URL: Documentation, https://developers.mindee.com/docs/python-sdk
Project-URL: Source, https://github.com/publicMindee/mindee-api-python
Platform: any
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Classifier: Operating System :: OS Independent
Classifier: Development Status :: 5 - Production/Stable
Classifier: Intended Audience :: Developers
Classifier: Topic :: Software Development :: Libraries
Classifier: License :: OSI Approved :: MIT License
Requires-Python: >=3.7
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: pikepdf (==5.1.2)
Requires-Dist: pytz (>=2022.1)
Requires-Dist: requests (~=2.28)
Provides-Extra: dev
Requires-Dist: black (==22.3.0) ; extra == 'dev'
Requires-Dist: mypy (==0.960) ; extra == 'dev'
Requires-Dist: pip-tools (~=6.8.0) ; extra == 'dev'
Requires-Dist: pylint (==2.12.2) ; extra == 'dev'
Requires-Dist: setuptools (==49.6.0) ; extra == 'dev'
Requires-Dist: isort (==5.10.1) ; extra == 'dev'
Requires-Dist: pre-commit (==2.18.1) ; extra == 'dev'
Requires-Dist: pydocstyle (==6.1.1) ; extra == 'dev'
Provides-Extra: docs
Requires-Dist: sphinx-rtd-theme (~=1.0.0) ; extra == 'docs'
Requires-Dist: sphinx (~=4.4.0) ; extra == 'docs'
Provides-Extra: test
Requires-Dist: pytest (==6.2.5) ; extra == 'test'
Requires-Dist: pytest-cov (==2.12.1) ; extra == 'test'

# Mindee API Helper Library for Python
Quickly and easily connect to Mindee's API services using Python.

## Quick Start
Here's the TL;DR of getting started.

First, get an [API Key](https://developers.mindee.com/docs/create-api-key)

Then, install this library:
```shell
pip install mindee
```

Finally, Python away!

### Off-the-Shelf Document
```python
from mindee import Client

# Init a new client and configure the Invoice API
mindee_client = Client().config_invoice("my-invoice-api-key")

# Load a file from disk and parse it
api_response = mindee_client.doc_from_path("/path/to/the/invoice.pdf").parse("invoice")

# Print a brief summary of the parsed data
print(api_response.invoice)
```

### Custom Document (API Builder)
```python
from mindee import Client

# Init a new client and configure your custom document
mindee_client = Client().config_custom_doc(
      document_type="pokemon-card",
      singular_name="card",
      plural_name="cards",
      account_name="pikachu",
      api_key="pokemon-card-api-key"
)

# Load a file from disk and parse it
api_response = mindee_client.doc_from_path("/path/to/the/card.jpg").parse("pokemon-card")

# Print a brief summary of the parsed data
print(api_response.card)
```

## Further Reading
There's more to it than that for those that need more features, or want to
customize the experience.

All the juicy details are described in the
**[Official Documentation](https://developers.mindee.com/docs/python-sdk)**.

## License
Copyright © Mindee

Available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
