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.1.0.tar.gz (27.5 kB view details)

Uploaded Source

Built Distribution

mindee-2.1.0-py3-none-any.whl (43.3 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: mindee-2.1.0.tar.gz
  • Upload date:
  • Size: 27.5 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.1.0.tar.gz
Algorithm Hash digest
SHA256 3e3a4c4345c516878f3ac737c096171ad23e65954295cee2add99c79012bd149
MD5 cb921e583251107bfd446ec3f4d895ad
BLAKE2b-256 819e58851f02a42599a24218d859b4b43a4cbd4ce1237dbe719cffc0f1c0c273

See more details on using hashes here.

File details

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

File metadata

  • Download URL: mindee-2.1.0-py3-none-any.whl
  • Upload date:
  • Size: 43.3 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.1.0-py3-none-any.whl
Algorithm Hash digest
SHA256 d009ccf4a32b73b6e854bf99f19ac448227f023ab5af7357fa76221c5e635805
MD5 7609039774ad1c09f5844c537e54e14b
BLAKE2b-256 799af18a04aeea9b698316f0014148fe908a7ccf1c36be9711d2c0b48be82fff

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