| Name | llama-index-readers-gitbook JSON |
| Version |
0.3.0
JSON |
| download |
| home_page | None |
| Summary | llama-index readers gitbook integration |
| upload_time | 2024-11-18 00:18:46 |
| maintainer | mckang |
| docs_url | None |
| author | thomas.kang |
| requires_python | <4.0,>=3.9 |
| license | MIT |
| keywords |
gitbook
|
| VCS |
|
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# LlamaIndex Readers Integration: Gitbook
## Overview
Simple Gitbook Reader allows loading data from a gitbook space. It collects & converts contents from gitbook space into documents used by LlamaIndex.
### Installation
You can install Gitbook Reader via pip:
```bash
pip install llama-index-readers-gitbook
```
### Usage
```python
from llama_index.readers.gitbook import SimpleGitbookReader
# Initialize SimpleGitbookReader
reader = SimpleGitbookReader(
api_token="<Gitbook API Token>", # Gitbook API Token
)
# load data from Gitbook
documents = reader.load_data(
space_id="<Gitbook Space Id>", # Id of the gitbook space
metadata_names=None, # Names of the fields to add to metadata attribute (available: 'path', 'title', 'description', 'parent')
)
```
Raw data
{
"_id": null,
"home_page": null,
"name": "llama-index-readers-gitbook",
"maintainer": "mckang",
"docs_url": null,
"requires_python": "<4.0,>=3.9",
"maintainer_email": null,
"keywords": "gitbook",
"author": "thomas.kang",
"author_email": "mc.kang08@gmail.com",
"download_url": "https://files.pythonhosted.org/packages/16/1e/cd8972db89d8a6411cc70b7359637f274e663b2487ceaf7ddd28123e93da/llama_index_readers_gitbook-0.3.0.tar.gz",
"platform": null,
"description": "# LlamaIndex Readers Integration: Gitbook\n\n## Overview\n\nSimple Gitbook Reader allows loading data from a gitbook space. It collects & converts contents from gitbook space into documents used by LlamaIndex.\n\n### Installation\n\nYou can install Gitbook Reader via pip:\n\n```bash\npip install llama-index-readers-gitbook\n```\n\n### Usage\n\n```python\nfrom llama_index.readers.gitbook import SimpleGitbookReader\n\n# Initialize SimpleGitbookReader\nreader = SimpleGitbookReader(\n api_token=\"<Gitbook API Token>\", # Gitbook API Token\n)\n\n# load data from Gitbook\ndocuments = reader.load_data(\n space_id=\"<Gitbook Space Id>\", # Id of the gitbook space\n metadata_names=None, # Names of the fields to add to metadata attribute (available: 'path', 'title', 'description', 'parent')\n)\n```\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "llama-index readers gitbook integration",
"version": "0.3.0",
"project_urls": null,
"split_keywords": [
"gitbook"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "2a939466778ef58aec490fd5f3ec4b67e9c87725f7507e6bdb2e4d68eddd4017",
"md5": "4516d68cce4ded0f7f2585ea2189f6fa",
"sha256": "4a198a3a559d165d6e01d152ea4f3cdb930b3bccb65bc8aa6a0f54aa664ac937"
},
"downloads": -1,
"filename": "llama_index_readers_gitbook-0.3.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "4516d68cce4ded0f7f2585ea2189f6fa",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": "<4.0,>=3.9",
"size": 4576,
"upload_time": "2024-11-18T00:18:45",
"upload_time_iso_8601": "2024-11-18T00:18:45.378530Z",
"url": "https://files.pythonhosted.org/packages/2a/93/9466778ef58aec490fd5f3ec4b67e9c87725f7507e6bdb2e4d68eddd4017/llama_index_readers_gitbook-0.3.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "161ecd8972db89d8a6411cc70b7359637f274e663b2487ceaf7ddd28123e93da",
"md5": "242ae7634b3fd097901acb7f0e6576ee",
"sha256": "2fa08dc9e7eb496b4569588774bed9fc8732bf7ea51ef0e106dade7206c23672"
},
"downloads": -1,
"filename": "llama_index_readers_gitbook-0.3.0.tar.gz",
"has_sig": false,
"md5_digest": "242ae7634b3fd097901acb7f0e6576ee",
"packagetype": "sdist",
"python_version": "source",
"requires_python": "<4.0,>=3.9",
"size": 3918,
"upload_time": "2024-11-18T00:18:46",
"upload_time_iso_8601": "2024-11-18T00:18:46.205461Z",
"url": "https://files.pythonhosted.org/packages/16/1e/cd8972db89d8a6411cc70b7359637f274e663b2487ceaf7ddd28123e93da/llama_index_readers_gitbook-0.3.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-11-18 00:18:46",
"github": false,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"lcname": "llama-index-readers-gitbook"
}
