Graphene: Python DSL for GraphQL
Project description
Graphene is a Python library for creating GraphQL schemas/types easly. It maps the models/fields to internal GraphQL objects without effort. Including automatic Django models conversion.
Installation
For instaling graphene, just run this command in your shell
pip install grapheneUsage
Example code of a GraphQL schema using Graphene:
Schema definition
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)Querying
Querying graphene.Schema is as simple as:
query = '''
query HeroNameQuery {
hero {
name
}
}
'''
result = schema.execute(query)Relay Schema
Graphene also supports Relay, check the Starwars Relay example!
class Ship(relay.Node):
'''A ship in the Star Wars saga'''
name = graphene.StringField(description='The name of the ship.')
@classmethod
def get_node(cls, id):
return Ship(getShip(id))
class Query(graphene.ObjectType):
ships = relay.ConnectionField(Ship, description='The ships used by the faction.')
node = relay.NodeField()
@resolve_only_args
def resolve_ships(self):
return [Ship(s) for s in getShips()]Django+Relay Schema
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
# excluxe_fields ('field_to_excluxe', ) # Exclude mapping this fields from the model
class Query(graphene.ObjectType):
node = relay.NodeField()Contributing
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 modeRelease history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
File details
Details for the file graphene-0.1.2.tar.gz.
File metadata
- Download URL: graphene-0.1.2.tar.gz
- Upload date:
- Size: 18.5 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | be70814fa2605ea366a652ffef0a4657741b1906b90bf547c4859f4f70d618ee |
|
| MD5 | b8026d3eb821b483734d3a591401275a |
|
| BLAKE2b-256 | 174800bf6e923460d13687f67fdb629519e4627ab2e3e80364c30e2548c57e98 |
