# StripeDocs Loader
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 import VectorStoreIndex
from llama_hub.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"])
```
Raw data
{
"_id": null,
"home_page": "",
"name": "llama-index-readers-stripe-docs",
"maintainer": "amorriscode",
"docs_url": null,
"requires_python": ">=3.8.1,<4.0",
"maintainer_email": "",
"keywords": "documentation,stripe",
"author": "Your Name",
"author_email": "you@example.com",
"download_url": "https://files.pythonhosted.org/packages/89/6b/311b5be9836e6f5870ec968ddb089cadc2512a46c8092bfd2f2093c3ea26/llama_index_readers_stripe_docs-0.1.4.tar.gz",
"platform": null,
"description": "# StripeDocs Loader\n\nThis loader asynchronously loads data from the [Stripe documentation](https://stripe.com/docs). It iterates through the Stripe sitemap to get all `/docs` references.\n\nIt is based on the [Async Website Loader](https://llamahub.ai/l/web-async_web).\n\n## Usage\n\n```python\nfrom llama_index import VectorStoreIndex\nfrom llama_hub.stripe_docs import StripeDocsReader\n\nloader = StripeDocsReader()\ndocuments = loader.load_data()\n\nindex = VectorStoreIndex.from_documents(documents)\n\nquery_engine = index.as_query_engine()\nquery_engine.query(\"How do I accept payments on my website?\")\n```\n\nThe `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`.\n\n## Filtering\n\nYou 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.\n\nThe default filters are set to `[\"/docs\"]` to scope everything to docs only.\n\n```python\ndocuments = loader.load_data(filters=[\"/terminal\"])\n```\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "llama-index readers stripe_docs integration",
"version": "0.1.4",
"project_urls": null,
"split_keywords": [
"documentation",
"stripe"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "1a6f3a17bfca39b933789826084d367adde9542e04ae147c51762ca90d5fa7bb",
"md5": "9e47d3900871deb0405a2c1469832d74",
"sha256": "a86dc9f32560eb30e16394f164002f2da88ce0ecfb723a3a6c3969438e6a80d2"
},
"downloads": -1,
"filename": "llama_index_readers_stripe_docs-0.1.4-py3-none-any.whl",
"has_sig": false,
"md5_digest": "9e47d3900871deb0405a2c1469832d74",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.8.1,<4.0",
"size": 3061,
"upload_time": "2024-02-21T21:30:19",
"upload_time_iso_8601": "2024-02-21T21:30:19.543899Z",
"url": "https://files.pythonhosted.org/packages/1a/6f/3a17bfca39b933789826084d367adde9542e04ae147c51762ca90d5fa7bb/llama_index_readers_stripe_docs-0.1.4-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "896b311b5be9836e6f5870ec968ddb089cadc2512a46c8092bfd2f2093c3ea26",
"md5": "d84032827994002a3fa413cb363b812a",
"sha256": "c2cf549ab8925f4c6dd353500e00cc7419afad564002a60697f399d311e8f0e5"
},
"downloads": -1,
"filename": "llama_index_readers_stripe_docs-0.1.4.tar.gz",
"has_sig": false,
"md5_digest": "d84032827994002a3fa413cb363b812a",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.8.1,<4.0",
"size": 2775,
"upload_time": "2024-02-21T21:30:21",
"upload_time_iso_8601": "2024-02-21T21:30:21.539101Z",
"url": "https://files.pythonhosted.org/packages/89/6b/311b5be9836e6f5870ec968ddb089cadc2512a46c8092bfd2f2093c3ea26/llama_index_readers_stripe_docs-0.1.4.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-02-21 21:30:21",
"github": false,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"lcname": "llama-index-readers-stripe-docs"
}
JSON