Skip to main content

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 graphene

Usage

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 install

After developing, the full test suite can be evaluated by running:

python setup.py test # Use --pytest-args="-v -s" for verbose mode

Project details


Release 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

graphene-0.1.6a1.tar.gz (20.3 kB view details)

Uploaded Source

File details

Details for the file graphene-0.1.6a1.tar.gz.

File metadata

  • Download URL: graphene-0.1.6a1.tar.gz
  • Upload date:
  • Size: 20.3 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No

File hashes

Hashes for graphene-0.1.6a1.tar.gz
Algorithm Hash digest
SHA256 7873a6fd6a848dc5751de8ec6c802b73f281ae3890a03415a21b3e903fda9858
MD5 16a35afb43f9e879b03b8e54db75a8bf
BLAKE2b-256 831dcefd58d0f4ba678d09689d29a6c203518746b4539cd009b6dfe8dfc84eb7

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page