Metadata-Version: 2.4
Name: llama-index-readers-graphql
Version: 0.5.0
Summary: llama-index readers graphql integration
Author-email: Your Name <you@example.com>
Maintainer: jexp
License-Expression: MIT
License-File: LICENSE
Keywords: apollo,gql,graphql
Requires-Python: <4.0,>=3.10
Requires-Dist: gql<4,>=3.5.0
Requires-Dist: llama-index-core<0.15,>=0.13.0
Requires-Dist: requests-toolbelt<2,>=1.0.0
Description-Content-Type: text/markdown

# GraphQL Loader

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

This loader loads documents via GraphQL queries from a GraphQL endpoint.
The user specifies a GraphQL endpoint URL with optional credentials to initialize the reader.
By declaring the GraphQL query and optional variables (parameters) the loader can fetch the nested result docs.

## Usage

Here's an example usage of the GraphQLReader.
You can test out queries directly [on the site](https://countries.trevorblades.com/)

```python
import os

from llama_index.readers.graphql import GraphQLReader

uri = "https://countries.trevorblades.com/"
headers = {}
query = """
    query getContinents {
        continents {
            code
            name
        }
    }
"""
reader = GraphQLReader(uri, headers)
documents = reader.query(query, variables={})
```

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.

It uses the [gql GraphQL library](https://pypi.org/project/gql/) for the GraphQL queries.
