===============================

Graphene GAE

.. image:: https://travis-ci.org/graphql-python/graphene-gae.svg?branch=master :target: https://travis-ci.org/graphql-python/graphene-gae

.. image:: https://coveralls.io/repos/github/graphql-python/graphene-gae/badge.svg?branch=master :target: https://coveralls.io/github/graphql-python/graphene-gae?branch=master

.. image:: https://img.shields.io/pypi/v/graphene-gae.svg :target: https://pypi.python.org/pypi/graphene-gae

A Google AppEngine integration library for Graphene <http://graphene-python.org>__

• Free software: BSD license
• Documentation: https://graphene_gae.readthedocs.org.

Upgrade Notes

If you're upgrading from an older version (pre 2.0 version) please check out the Graphene Upgrade Guide <https://github.com/graphql-python/graphene/blob/master/UPGRADE-v2.0.md>__.

Installation

To install Graphene-GAE on your AppEngine project, go to your project folder and runthis command in your shell:

.. code:: bash

pip install graphene-gae -t ./libs

This will install the library and its dependencies to the libs folder under your projects root - so the dependencies get uploaded withyour GAE project when you publish your app.

Make sure the libs folder is in your python path by adding the following to your appengine_config.py:

.. code:: python

import sys

for path in ['libs']:
    if path not in sys.path:
        sys.path[0:0] = [path]

Examples

Here's a simple GAE model:

.. code:: python

class Article(ndb.Model):
    headline = ndb.StringProperty()
    summary = ndb.TextProperty()
    text = ndb.TextProperty()

    author_key = ndb.KeyProperty(kind='Author')

    created_at = ndb.DateTimeProperty(auto_now_add=True)
    updated_at = ndb.DateTimeProperty(auto_now=True)

To create a GraphQL schema for it you simply have to write the following:

.. code:: python

import graphene
from graphene_gae import NdbObjectType

class ArticleType(NdbObjectType):
    class Meta:
        model = Article

class Query(graphene.ObjectType):
    articles = graphene.List(ArticleType)

    @graphene.resolve_only_args
    def resolve_articles(self):
        return Article.query()

schema = graphene.Schema(query=QueryRoot)

Then you can simply query the schema:

.. code::python

query = '''
    query GetArticles {
      articles {
        headline,
        summary,
        created_at
      }
    }
'''
result = schema.execute(query)

To learn more check out the following examples <examples/>__:

• Starwars <examples/starwars>__

Contributing

After cloning this repo, ensure dependencies are installed by running:

.. code:: sh

make deps
make install

Make sure tests and lint are running:

.. code:: sh

make test
make lint

History

1.0.7 (TBD)

• GraphQLHandler GET supoort (PR #27)

1.0.6 (2016-12-06)

• Fixed DeadlineExceededError import swo connections properly handle timeouts

1.0.5 (2016-11-23)

• Improved behavior of NdbConnectionField when transform_edges also filters out some edges (PR #26)

1.0.3 (2016-11-22)

• Added transform_edges to NdbConnectionField (PR #25)

1.0.2 (2016-10-20)

• Added _handle_graphql_errors hook to GraphQLHandler

1.0.1 (2016-09-28)

• Added missing support for StructuredProperty

1.0 (2016-09-26)

• Upgraded to Graphene 1.0

0.1.9 (2016-08-17)

• Each NdbObject now exposes an ndbId String field that maps to the entity's key.id()
• Added ndb boolean argument to NdbKeyStringField so now when looking at KeyProperty we can fetch either global GraphQL id or the NDB internal id.

0.1.8 (2016-08-16)

• Made connection_from_ndb_query resilient to random ndb timeouts

0.1.7 (2016-06-14)

• BREAKING: Fixed behavior of KeyProperty to expose GraphQL Global IDs instead of internal ndb.Key values. (PR #16)

0.1.6 (2016-06-10)

• Changing development status to Beta
• Added NdbNode.global_id_to_key PR #15

0.1.5 (2016-06-08)

• Fixed behavior of ndb.KeyProperty (PR #14)

0.1.4 (2016-06-02)

• NdbConnectionField added arguments that can be used in quert:
  • keys_only - to execute a keys only query
  • batch_size - to control the NDB query iteration batch size
  • page_size - control the page sizes when paginating connection results
• Added support for LocalStructuredProperty.
  • Given a property ndb.LocalStructuredType(Something) it will automatically map to a Field(SomethingType) - SomethingType has to be part of the schema.
  • Support for repeated and required propeties.

0.1.3 (2016-05-27)

• Added graphene_gae.webapp2.GraphQLHandler - a basic HTTP Handler to process GraphQL requests

0.1.1 (2016-05-25)

• Updated graphene dependency to latest 0.10.1 version.
  • NdbConnection.from_list now gets context as parameter

0.1.0 (2016-05-11)

• First release on PyPI.