Metadata-Version: 2.1
Name: llama-index-readers-readme
Version: 0.3.0
Summary: llama-index readers readme.com integration
License: MIT
Author: Gonzalo Rios
Author-email: contacto@gonzalorios.cl
Requires-Python: >=3.9,<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: beautifulsoup4 (>=4.12.3,<5.0.0)
Requires-Dist: llama-index-core (>=0.12.0,<0.13.0)
Requires-Dist: requests (>=2.31.0,<3.0.0)
Description-Content-Type: text/markdown

# Readme.com Loader

```bash
pip install llama-index-readers-readme
```

This loader fetches the text from [Readme](https://readme.com/) docs guides using the Readme API. It also uses the BeautifulSoup library to parse the HTML and extract the text from the docs.

## Usage

To use this loader, you need to pass in the API Key of a Readme account.

```python
from llama_index.readers.readme import ReadmeReader

loader = ReadmeReader(api_key="YOUR_API_KEY")
documents = loader.load_data()
```

This loader is designed to be used as a way to load data into [LlamaIndex](https://github.com/run-llama/llama_index/).

