Metadata-Version: 2.1
Name: llama-index-readers-mangadex
Version: 0.1.0
Summary: llama-index readers mangadex integration
License: MIT
Author: Your Name
Author-email: you@example.com
Requires-Python: >=3.8.1,<3.12
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
Requires-Dist: llama-index-core (==0.10.0)
Description-Content-Type: text/markdown

# MangaDex Loader

This loader fetches information from the MangaDex API, by manga title.

## Usage

```python
from llama_index import download_loader

MangaDexReader = download_loader("MangaDexReader")

loader = MangaDexReader()
documents = loader.load_data(
    titles=["manga title 1", "manga title 2"], lang="en"
)
```

## Output

### Text

Document text is the manga title. There are alternate titles for many manga, so the canonical title will be returned, even if it is not the title that the user queried with.

### Extra Info

| Data                              | Description                                                                                        |
| --------------------------------- | -------------------------------------------------------------------------------------------------- |
| id (str)                          | MangaDex manga id                                                                                  |
| author (str)                      | Author's full name                                                                                 |
| artist (str)                      | Artist's full name                                                                                 |
| description (str)                 | Manga description                                                                                  |
| original_language (str)           | The language of the source material (before translation)                                           |
| tags (List[str])                  | Describes the manga's genre, e.g. "slice of life"                                                  |
| chapter_count (int)               | How many chapters exist in the requested language                                                  |
| latest_chapter_published_at (str) | Timestamp (YYYY-MM-DDTHH:MM:SS in timezone UTC+0) for the latest chapter in the requested language |

## Examples

This loader is designed to be used as a way to load data into [LlamaIndex](https://github.com/run-llama/llama_index/tree/main/llama_index) and/or subsequently used as a Tool in a [LangChain](https://github.com/hwchase17/langchain) Agent.

