ghgql 0.0.11

Thin wrapper for interacting with the Github GraphQL API

ghgql

Thin wrapper for interacting with the Github GraphQL API.

Status

Documentation

Please find the documentation and usage examples here: https://ghgql.readthedocs.io/en/latest/

Installation

$ pip install ghgql

Usage

For a more in-depth example, take a look at the example in the documentation. Here's a basic example.

import os
import ghgql

query = """
query ($searchQuery: String!) {
  search(query: $searchQuery, type: ISSUE, first: 1) {
    edges {
      node {
        ... on Issue {
          id
          number
          title
          url
        }
      }
    }
  }
}
"""

with ghgql.GithubGraphQL(token=os.getenv("GITHUB_TOKEN")) as ghapi:
    result = ghapi.query(query=query, variables={"searchQuery": "llvm/llvm-project"})
    print(result.get("search.edges"))

Should output something like this:

[{'node': {'id': 'I_kwDOHicqdc5RG-tC',
   'number': 16,
   'title': 'llvm/llvm-project',
   'url': 'https://github.com/KhushP786/open-sauced-goals/issues/16'}}]

Contributing

Interested in contributing? Check out the contributing guidelines. Please note that this project is released with a Code of Conduct. By contributing to this project, you agree to abide by its terms.

Commit message conventions and semantic versioniong (semver)

We use semantic versioning and these commit message conventions can be used to automatically bump the version number and generate the changelog.

License

ghgql was created by Konrad Kleine. It is licensed under the terms of the MIT license.

Credits

ghgql was created with cookiecutter and the py-pkgs-cookiecutter template.