Skip to main content

Mindee API helper library for Python

Project description

Mindee API Helper Library for 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-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)

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.

License

Copyright © Mindee

Distributed under 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.0.0.tar.gz (81.4 kB view details)

Uploaded Source

Built Distribution

mindee-2.0.0-py3-none-any.whl (96.5 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: mindee-2.0.0.tar.gz
  • Upload date:
  • Size: 81.4 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.7.1 importlib_metadata/4.8.2 pkginfo/1.8.2 requests/2.25.1 requests-toolbelt/0.9.1 tqdm/4.62.3 CPython/3.9.7

File hashes

Hashes for mindee-2.0.0.tar.gz
Algorithm Hash digest
SHA256 b4599e8eac420ecfc5ba47e93e838c423c5000cd0e593ae671b084954b65032a
MD5 b1c6ba53bd378f777ff3327da01db4fc
BLAKE2b-256 6d146e48a62eaffbae29395321c91922ad4de6cd43584feb4d78a15801be29ec

See more details on using hashes here.

File details

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

File metadata

  • Download URL: mindee-2.0.0-py3-none-any.whl
  • Upload date:
  • Size: 96.5 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.7.1 importlib_metadata/4.8.2 pkginfo/1.8.2 requests/2.25.1 requests-toolbelt/0.9.1 tqdm/4.62.3 CPython/3.9.7

File hashes

Hashes for mindee-2.0.0-py3-none-any.whl
Algorithm Hash digest
SHA256 376586c461726d3cb5b050096a8be2c092a0c990c8e957a38f8f262f624d53ec
MD5 904829a4c6edb17304115279de194139
BLAKE2b-256 45415ee003f9a94c3eedac80f21d7cbbf75044b3cf76ec0b1d5d85645b6c26f0

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