Graphene is a Python library for building GraphQL schemas/types fast and easily.
- Easy to use: It maps the models/fields to internal GraphQL objects without effort.
- Relay: Graphene has builtin support for Relay
- Django: Automatic Django models conversion. See an example Django implementation
For instaling graphene, just run this command in your shell
pip install grapheneExample code of a GraphQL schema using Graphene:
class Character(graphene.Interface):
id = graphene.IDField()
name = graphene.StringField()
friends = graphene.ListField('self')
def resolve_friends(self, args, *_):
return [Human(f) for f in self.instance.friends]
class Human(Character):
homePlanet = graphene.StringField()
class Query(graphene.ObjectType):
human = graphene.Field(Human)
schema = graphene.Schema(query=Query)Then Querying graphene.Schema is as simple as:
query = '''
query HeroNameQuery {
hero {
name
}
}
'''
result = schema.execute(query)Graphene also supports Relay, check the Starwars Relay example!
class Ship(relay.Node):
name = graphene.StringField()
@classmethod
def get_node(cls, id):
return Ship(your_ship_instance)
class Query(graphene.ObjectType):
ships = relay.ConnectionField(Ship)
node = relay.NodeField()If you want to use graphene with your Django Models check the Starwars Django example!
class Ship(DjangoNode):
class Meta:
model = YourDjangoModelHere
# only_fields = ('id', 'name') # Only map this fields from the model
# exclude_fields ('field_to_exclude', ) # Exclude mapping this fields from the model
class Query(graphene.ObjectType):
node = relay.NodeField()After cloning this repo, ensure dependencies are installed by running:
python setup.py installAfter developing, the full test suite can be evaluated by running:
python setup.py test # Use --pytest-args="-v -s" for verbose mode