https://github.com/sypht-team/sypht-python-client
A python client for the Sypht API
https://github.com/sypht-team/sypht-python-client
api-client data-extraction document-capture extract extract-data-from-pdf extract-fields information-extraction invoice invoice-parser pdf-parser python python3 python3-library receipt-capture receipt-reader receipt-scanner receipt-scanning sypht sypht-api sypht-python-client
Last synced: 7 months ago
JSON representation
A python client for the Sypht API
- Host: GitHub
- URL: https://github.com/sypht-team/sypht-python-client
- Owner: sypht-team
- License: mit
- Created: 2018-08-20T07:40:01.000Z (over 7 years ago)
- Default Branch: master
- Last Pushed: 2024-07-10T04:33:44.000Z (over 1 year ago)
- Last Synced: 2025-01-05T02:09:42.708Z (about 1 year ago)
- Topics: api-client, data-extraction, document-capture, extract, extract-data-from-pdf, extract-fields, information-extraction, invoice, invoice-parser, pdf-parser, python, python3, python3-library, receipt-capture, receipt-reader, receipt-scanner, receipt-scanning, sypht, sypht-api, sypht-python-client
- Language: Python
- Homepage: https://sypht.com
- Size: 165 KB
- Stars: 162
- Watchers: 5
- Forks: 5
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
[](https://badge.fury.io/py/sypht) [](https://app.travis-ci.com/github/sypht-team/sypht-python-client) [](https://codecov.io/gh/sypht-team/sypht-python-client)
# Sypht Python Client
This repository is a Python 3+ reference client implementation for the Sypht API at https://api.sypht.com.
## About Sypht
[Sypht](https://sypht.com) is a SaaS [API](<(https://docs.sypht.com/)>) which extracts key fields from documents and images.
For example, you can upload an image or pdf of a bill or invoice and extract the amount due, due date, invoice number and biller information.
For an up-to-date list of supported extraction types, see the [Marketplace](https://app.sypht.com/marketplace).
## Getting started
To get started you'll need API credentials, i.e. a `` and ``, which can be obtained by registering for an [account](https://www.sypht.com/)
## Installation
Latest version is available via pypi:
```
pip install sypht
```
## Usage
```python
from sypht.client import SyphtClient
sc = SyphtClient('', '')
with open('invoice.png', 'rb') as f:
fid = sc.upload(f, products=["forms-&-reports"])
print(sc.fetch_results(fid))
```
or run it via the command line:
```
export SYPHT_API_KEY=":"
sypht extract --product invoices path/to/your/document.pdf
```
## Documentation
Visit the [Marketplace](https://app.sypht.com/marketplace/products) to see the full set of available AI Products, document types and data fields supported.
Advanced workflows, features and field data structures are covered in the [Dev Guide](https://sypht.gitbook.io/sypht/).
## License
The software in this repository is available as open source under the terms of the [MIT License](https://github.com/sypht-team/sypht-python-client/blob/master/LICENSE).
## Code of Conduct
Everyone interacting in the project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/sypht-team/sypht-python-client/blob/master/CODE_OF_CONDUCT.md).