Metadata-Version: 2.1
Name: document-insighter
Version: 0.0.11
Summary: Document Insighter Python Client
Home-page: https://github.com/deepsite/document-insighter-python
Author: Wang Kai
Author-email: wangkai@godeepsite.com
License: MIT
Project-URL: Bug Tracker, https://github.com/deepsite/document-insighter-python/issues
Description-Content-Type: text/markdown
Requires-Dist: requests (==2.31.0)
Requires-Dist: requests-oauthlib (==1.3.1)
Requires-Dist: dataclasses-json (==0.5.7)
Requires-Dist: polling2 (==0.5.0)


# Document Insighter Client

Document Insighter Client is a Python library for interacting with the Document Insighter API. It allows you to query document extractions and process the data for various document types.

## Getting Started

### Prerequisites

- Python 3.7+

### Installation

1. Install the required dependencies using the provided `requirements.txt`:

    ```bash
    pip install -U document-insighter
    ```

### Getting Started

The following steps demonstrate how to use the Document Insighter Client in your Python project:


#### Okta Based Authentication

- Include the necessary environment variables in your project or by setting them in your environment. The required environment variables are:
    - `INSIGHTER_CLIENT_IDP`
    - `INSIGHTER_CLIENT_ID`
    - `INSIGHTER_CLIENT_SECRET`
    - `INSIGHTER_CLIENT_TOKEN_PATH`
    - `INSIGHTER_TENANT`

- Now, let's proceed to the next step. Install the required packages for the example script.
```bash
pip install pandas==2.2.2
```

- Once the packages are installed, you can run the example to fetch and print out document extractions within the specified date range.
```bash
python example/query_extractions_okta.py --category NB_COA --start_date 2024-05-01 --end_date 2024-07-10 --page_size 50 --tags HB_Ops tag1 tag2
```



