# 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
```
Raw data
{
"_id": null,
"home_page": "https://github.com/deepsite/document-insighter-python",
"name": "document-insighter",
"maintainer": null,
"docs_url": null,
"requires_python": null,
"maintainer_email": null,
"keywords": null,
"author": "Wang Kai",
"author_email": "wangkai@godeepsite.com",
"download_url": null,
"platform": null,
"description": "\r\n# Document Insighter Client\r\n\r\nDocument 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.\r\n\r\n## Getting Started\r\n\r\n### Prerequisites\r\n\r\n- Python 3.7+\r\n\r\n### Installation\r\n\r\n1. Install the required dependencies using the provided `requirements.txt`:\r\n\r\n ```bash\r\n pip install -U document-insighter\r\n ```\r\n\r\n### Getting Started\r\n\r\nThe following steps demonstrate how to use the Document Insighter Client in your Python project:\r\n\r\n\r\n#### Okta Based Authentication\r\n\r\n- Include the necessary environment variables in your project or by setting them in your environment. The required environment variables are:\r\n - `INSIGHTER_CLIENT_IDP`\r\n - `INSIGHTER_CLIENT_ID`\r\n - `INSIGHTER_CLIENT_SECRET`\r\n - `INSIGHTER_CLIENT_TOKEN_PATH`\r\n - `INSIGHTER_TENANT`\r\n\r\n- Now, let's proceed to the next step. Install the required packages for the example script.\r\n```bash\r\npip install pandas==2.2.2\r\n```\r\n\r\n- Once the packages are installed, you can run the example to fetch and print out document extractions within the specified date range.\r\n```bash\r\npython 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\r\n```\r\n\r\n\r\n\r\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "Document Insighter Python Client",
"version": "0.0.11",
"project_urls": {
"Bug Tracker": "https://github.com/deepsite/document-insighter-python/issues",
"Homepage": "https://github.com/deepsite/document-insighter-python"
},
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "955c16cb61e6e922e4eb6d59ead1e365757411bb586857ce4f1f131f28c1a583",
"md5": "f1dd6de172319546515d6ea8b091f3c6",
"sha256": "30480cab8bb2dcfecfc57b584115d2559198126ca93613eb396d5d9be1c394ce"
},
"downloads": -1,
"filename": "document_insighter-0.0.11-py3-none-any.whl",
"has_sig": false,
"md5_digest": "f1dd6de172319546515d6ea8b091f3c6",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": null,
"size": 7227,
"upload_time": "2024-07-31T04:49:49",
"upload_time_iso_8601": "2024-07-31T04:49:49.611249Z",
"url": "https://files.pythonhosted.org/packages/95/5c/16cb61e6e922e4eb6d59ead1e365757411bb586857ce4f1f131f28c1a583/document_insighter-0.0.11-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-07-31 04:49:49",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "deepsite",
"github_project": "document-insighter-python",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"requirements": [
{
"name": "requests",
"specs": [
[
"==",
"2.31.0"
]
]
},
{
"name": "requests-oauthlib",
"specs": [
[
"==",
"1.3.1"
]
]
},
{
"name": "dataclasses-json",
"specs": [
[
"==",
"0.5.7"
]
]
},
{
"name": "polling2",
"specs": [
[
"==",
"0.5.0"
]
]
},
{
"name": "pytest",
"specs": []
}
],
"lcname": "document-insighter"
}
JSON
