smartextract 0.5

smartextract Python SDK

smartextract Python SDK

This package provides convenient access to the smartextract REST API for Python applications.

Installation

This package requires Python 3.9 or higher and is available from PyPI:

pip install smartextract

Usage

To make your first request to the smartextract API, first make sure that you have signed up at https://app.smartextract.ai/. Then, try the following:

import smartextract
client = smartextract.Client(username=YOUR_USERNAME, password=YOUR_PASSWORD)
info = client.get_user_info()
print(info)

You may also generate an API key and use it instead of your username and password to initialize the client.

For more information, use your IDE to explore the methods of the Client object or refer to the user guide.

CLI

This package also offers a command line interface. To enable a few additional CLI features, install it with:

pip install smartextract[cli-extras]

Then type, for instance

smartextract get-user-info

to make a request, and

smartextract --help

for more information on all available commands and switches.

To avoid typing your username and password every time, generate an API key and set your environment variable SMARTEXTRACT_API_KEY. Alternatively, you can use short-lived API tokens, for example like this:

export SMARTEXTRACT_API_KEY="$(smartextract login YOUR_USERNAME)"
# or, to avoid typing your password interactively
export SMARTEXTRACT_API_KEY="$(cat my-password.txt | smartextract login YOUR_USERNAME)"

Finally, see smartextract completion --help for instructions on how to set up command-line completion in your shell.