Skip to content

Commit bdd8728

Browse files
authored
Merge pull request #7 from Zipstack/docs/update-readme-multi-client-support
docs: update README to reflect multi-client architecture
2 parents a86f86d + 6833e59 commit bdd8728

File tree

1 file changed

+8
-3
lines changed

1 file changed

+8
-3
lines changed

README.md

Lines changed: 8 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Unstract API Hub Python Client
22

3-
A Python client for the Unstract ApiHub service that provides a clean, Pythonic interface for document processing APIs following the extract → status → retrieve pattern.
3+
A comprehensive Python client library for Unstract APIHUB services that provides clean, Pythonic interfaces for multiple document processing APIs including table extraction, document splitting, and generic document processing with dynamic endpoints.
44

55
[![Python Version](https://img.shields.io/badge/python-3.12+-blue.svg)](https://python.org)
66
[![PyPI Version](https://img.shields.io/pypi/v/apihub-python-client)](https://pypi.org/project/apihub-python-client/)
@@ -12,13 +12,18 @@ A Python client for the Unstract ApiHub service that provides a clean, Pythonic
1212

1313
## 🚀 Features
1414

15-
- **Simple API Interface**: Clean, easy-to-use client for Unstract ApiHub services
16-
- **File Processing**: Support for document processing with file uploads
15+
- **Multi-Client Architecture**: Three specialized clients for different use cases
16+
- `ApiHubClient`: Table extraction and discovery APIs
17+
- `DocSplitterClient`: Document splitting and chunking services
18+
- `GenericUnstractClient`: Dynamic endpoint processing (invoice, contract, receipt, etc.)
19+
- **File Processing**: Support for document processing with file uploads across all clients
1720
- **Status Monitoring**: Track processing status with polling capabilities
1821
- **Error Handling**: Comprehensive exception handling with meaningful messages
1922
- **Flexible Parameters**: Support for custom parameters and configurations
2023
- **Automatic Polling**: Optional wait-for-completion functionality
2124
- **Type Safety**: Full type hints for better development experience
25+
- **Batch Processing**: Built-in support for processing multiple documents
26+
- **Integration Ready**: Easy integration between different client services
2227

2328
## 📦 Installation
2429

0 commit comments

Comments
 (0)