Welcome to GitHubGQL’s documentation!

GitHubGQL provides a simplified, opinionated way to access the GitHub GraphQL API, particularly with respect to handling paging.

Check out the Usage section for further information, including Installation of the library.

Note

This project is under active development.

Contents

• Usage
  • Installation
  • Querying from the GitHub GraphQL API
• Reference
  • Main class: GitHubGQL
    • GitHubGQL
      • GitHubGQL.Callback
      • GitHubGQL.Iterator
      • GitHubGQL.Merger
      • GitHubGQL.ResultPage
      • GitHubGQL.execute_all()
      • GitHubGQL.execute_callback()
      • GitHubGQL.execute_iter()
  • Other Classes
    • BearerTokenAuth
    • Clock
    • Config
    • Merger
    • Paginator
    • PathKey
    • Query
    • Results
    • Schema