Get started with Parble
Transform the way you process documents and extract valuable data with advanced Intelligent Document Processing.
Python SDK
This guide will help you get the most out of the Parble Python SDK to easily extract data from your documents.
We will explain how to use the SDK in a new or existing inbox. Want to test in your own terminal before integrating? Please check the .
Feel free to check the full documentation on our dedicated .
Installation
It is a prerequisite that you have installed Python. If you haven't, please follow the instructions on .
To install the Parble Python SDK, run the following command in your terminal:
pip install parbleUsage
To use the Parble Python SDK, you will need to import the package, initialize the client and call the method to extract the data from your documents.
Importing the Parble module
To import the Parble module run the following command:
from parble import ParbleSDKInitializing the Parble client
To initialize the client, provide your API key. You can find your API key and tenant name in your dashboard after login in.
parble = ParbleSDK(url="https://api.parble.com/v1/YOUR_TENANT_ID", api_key="YOUR_API_KEY")Processing files with Parble
To process your files, call the method “post” inside the “files” class of the Parble client and provide the file you want to process.
You only need to provide the file path, the endpoint is designed to take care of the rest, such as splitting and classifying the file and afterwards extracting the relevant information from it.
The method returns the output with the extracted data from your file. Checking the return can be done as shown in the example below.
Example print the return Object:
file = parble.files.post("PATH_TO_YOUR_FILE", inbox_id="INBOX_ID")
print(file)Extra features
The Parble Python SDK also provides other built-in methods. We invite you to check out the github repository to see the full documentation of the SDK. Some of the examples would be:
- Obtain the output from a previously processed file id
- Check your tenant usage stats
- Manage your API keys
- Consult the balance of your account