Skip to content

Commit 70f9439

Browse files
authored
Merge pull request #56 from landing-ai/refactor-readme-formatting
refactor to look neat
2 parents d9e1a5c + d480681 commit 70f9439

2 files changed

Lines changed: 29 additions & 8 deletions

File tree

README.md

Lines changed: 29 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,15 +1,36 @@
11
<!-- @format -->
22

3-
# LandingAI ADE Python API library
3+
<!-- @format -->
4+
5+
<div align="center">
6+
7+
<img src="logo.png" alt="LandingAI" width="420" />
8+
9+
**Agentic Document Extraction Python Library**
10+
11+
[![PyPI version](https://img.shields.io/pypi/v/landingai-ade.svg?label=pypi%20\(stable\))](https://pypi.org/project/landingai-ade/)
12+
![Python 3.9+](https://img.shields.io/badge/python-3.9%2B-blue)
13+
[![License](https://img.shields.io/pypi/l/landingai-ade)](https://pypi.org/project/landingai-ade/)
14+
15+
16+
**[Playground](https://va.landing.ai) · [Discord](https://discord.com/invite/RVcW3j9RgR) · [Blog](https://landing.ai/blog) · [Docs](https://docs.landing.ai/ade/ade-overview)**
17+
18+
</div>
19+
20+
21+
A Python library for interacting with the **LandingAI Agentic Document Extraction REST API**, designed for flexibility, reliability, clarity, and performance. Built for Python 3.9+ and generated with [Stainless](https://www.stainless.com/).
422

5-
<!-- prettier-ignore -->
6-
[![PyPI version](https://img.shields.io/pypi/v/landingai-ade.svg?label=pypi%20(stable))](https://pypi.org/project/landingai-ade/)
723

8-
The LandingAI ADE Python library provides convenient access to the LandingAI ADE REST API from any Python 3.9+
9-
application. The library includes type definitions for all request params and response fields,
10-
and offers both synchronous and asynchronous clients powered by [httpx](https://github.com/encode/httpx).
24+
## ✨ Features
1125

12-
It is generated with [Stainless](https://www.stainless.com/).
26+
* ✅ Fully-typed SDK with Pydantic response models
27+
* ⚡️ Sync & Async clients
28+
* 📄 Large document processing via async jobs
29+
* 🔁 Built-in retries with exponential backoff
30+
* 🔐 Secure API key handling
31+
* 📦 Seamless file uploads
32+
* 🧩 Schema-based data extraction
33+
* 🔌 Pluggable HTTP backends (`httpx` or `aiohttp`)
1334

1435
## Documentation
1536

@@ -107,7 +128,7 @@ client = LandingAIADE(apikey=os.environ.get("VISION_AGENT_API_KEY"))
107128
response = client.extract(
108129
schema=schema,
109130
# use markdown= for local files, markdown_url= for remote URLs
110-
markdown=Path('path/to/file.md')
131+
markdown=Path("path/to/file.md")
111132
)
112133
```
113134

logo.png

37.2 KB
Loading

0 commit comments

Comments
 (0)