Metadata-Version: 2.1
Name: llama-index-readers-gitbook
Version: 0.2.0
Summary: llama-index readers gitbook integration
License: MIT
Keywords: gitbook
Author: thomas.kang
Author-email: mc.kang08@gmail.com
Maintainer: mckang
Requires-Python: >=3.8.1,<4.0
Classifier: License :: OSI Approved :: MIT License
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: llama-index-core (>=0.11.0,<0.12.0)
Requires-Dist: pymongo (>=4.6.1,<5.0.0)
Description-Content-Type: text/markdown

# 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')
)
```

