Skip to main content

Mindee API helper library for Python

Project description

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

Then, install this library:

pip install mindee

Finally, Python away!

Off-the-Shelf Document

from mindee import Client

# Init a new client and configure the Invoice API
mindee_client = Client().config_invoice("my-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.document)

Custom Document (API Builder)

from mindee import Client

# Init a new client and configure your custom document
mindee_client = Client().config_custom_doc(
    account_name="john",
    document_type="wnine",
    api_key="my-api-key"
)

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

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

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.

License

Copyright © Mindee

Available as open source under the terms of the MIT License.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

mindee-2.6.0.tar.gz (32.0 kB view details)

Uploaded Source

Built Distribution

mindee-2.6.0-py3-none-any.whl (44.6 kB view details)

Uploaded Python 3

File details

Details for the file mindee-2.6.0.tar.gz.

File metadata

  • Download URL: mindee-2.6.0.tar.gz
  • Upload date:
  • Size: 32.0 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.1 CPython/3.8.10

File hashes

Hashes for mindee-2.6.0.tar.gz
Algorithm Hash digest
SHA256 d190947b824aba6e29ce28a46d92c333f9648ccc9de84f4d304b1a3a86b76292
MD5 da7d90fd53cda61e0886d2914c441c3f
BLAKE2b-256 435ca3fb1891911eb595d4a372a75abb6547a168ea620f6e0000fb62eb144ddf

See more details on using hashes here.

File details

Details for the file mindee-2.6.0-py3-none-any.whl.

File metadata

  • Download URL: mindee-2.6.0-py3-none-any.whl
  • Upload date:
  • Size: 44.6 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.1 CPython/3.8.10

File hashes

Hashes for mindee-2.6.0-py3-none-any.whl
Algorithm Hash digest
SHA256 cdc9a657615af1c8412dabc0ae5822c7c3360f4faa00230fa3930a1defcb871f
MD5 616964439c3994da9377717ce4f92bb9
BLAKE2b-256 287cf6ae56a6b49a93523bac86c3c16452fb2f4a0978e8296276428bec817da4

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page