Metadata-Version: 2.1
Name: llama-index-readers-stripe-docs
Version: 0.3.1
Summary: llama-index readers stripe_docs integration
License: GPL-3.0-or-later
Keywords: documentation,stripe
Author: Your Name
Author-email: you@example.com
Maintainer: amorriscode
Requires-Python: >=3.9,<4.0
Classifier: License :: OSI Approved :: GNU General Public License v3 or later (GPLv3+)
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Requires-Dist: defusedxml (>=0.7.1,<0.8.0)
Requires-Dist: html2text (>=2024.2.26,<2025.0.0)
Requires-Dist: llama-index-core (>=0.12.0,<0.13.0)
Requires-Dist: llama-index-readers-web (>=0.3.0,<0.4.0)
Requires-Dist: urllib3 (>=2.1.0,<3.0.0)
Description-Content-Type: text/markdown

# StripeDocs Loader

```bash
pip install llama-index-readers-stripe-docs
```

This loader asynchronously loads data from the [Stripe documentation](https://stripe.com/docs). It iterates through the Stripe sitemap to get all `/docs` references.

It is based on the [Async Website Loader](https://llamahub.ai/l/web-async_web).

## Usage

```python
from llama_index.core import VectorStoreIndex
from llama_index.readers.stripe_docs import StripeDocsReader

loader = StripeDocsReader()
documents = loader.load_data()

index = VectorStoreIndex.from_documents(documents)

query_engine = index.as_query_engine()
query_engine.query("How do I accept payments on my website?")
```

The `StripeDocsReader` allows you to return plain text docs by setting `html_to_text=True`. You can also adjust the maximum concurrent requests by setting `limit=10`.

## Filtering

You can filter pages from the Stripe sitemap by adding the _filters_ argument to the load_data method. This allows you to control what pages from the Stripe website, including documentation, will be loaded.

The default filters are set to `["/docs"]` to scope everything to docs only.

```python
documents = loader.load_data(filters=["/terminal"])
```

