From 6833e59a43e30e66c19be6a44268cb2d5796b743 Mon Sep 17 00:00:00 2001 From: Jaseem Jas Date: Sun, 24 Aug 2025 12:47:53 +0530 Subject: [PATCH] docs: update README to reflect multi-client architecture MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit - Updated main description to highlight comprehensive multi-client library - Enhanced features section to showcase three specialized clients: * ApiHubClient for table extraction and discovery APIs * DocSplitterClient for document splitting services * GenericUnstractClient for dynamic endpoint processing - Added batch processing and integration capabilities to features 🤖 Generated with [Claude Code](https://claude.ai/code) Co-Authored-By: Claude --- README.md | 11 ++++++++--- 1 file changed, 8 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index cbaea6f..8094923 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,6 @@ # Unstract API Hub Python Client -A Python client for the Unstract ApiHub service that provides a clean, Pythonic interface for document processing APIs following the extract → status → retrieve pattern. +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. [![Python Version](https://img.shields.io/badge/python-3.12+-blue.svg)](https://python.org) [![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 ## 🚀 Features -- **Simple API Interface**: Clean, easy-to-use client for Unstract ApiHub services -- **File Processing**: Support for document processing with file uploads +- **Multi-Client Architecture**: Three specialized clients for different use cases + - `ApiHubClient`: Table extraction and discovery APIs + - `DocSplitterClient`: Document splitting and chunking services + - `GenericUnstractClient`: Dynamic endpoint processing (invoice, contract, receipt, etc.) +- **File Processing**: Support for document processing with file uploads across all clients - **Status Monitoring**: Track processing status with polling capabilities - **Error Handling**: Comprehensive exception handling with meaningful messages - **Flexible Parameters**: Support for custom parameters and configurations - **Automatic Polling**: Optional wait-for-completion functionality - **Type Safety**: Full type hints for better development experience +- **Batch Processing**: Built-in support for processing multiple documents +- **Integration Ready**: Easy integration between different client services ## 📦 Installation