Skip to main content

Graphene: Python DSL for GraphQL

Project description

Graphene is a Python library for building GraphQL schemas/types fast and easily.

  • Easy to use: Graphene helps you use GraphQL in Python without effort.

  • Relay: Graphene has builtin support for Relay

  • Django: Automatic Django model mapping to Graphene Types. Check a fully working Django implementation

What is supported in this Python version? Everything: Interfaces, ObjectTypes, Scalars, Unions and Relay (Nodes, Connections), in addition to queries, mutations and subscriptions.

Installation

For instaling graphene, just run this command in your shell

pip install graphene
# Or in case of need Django model support
pip install graphene[django]

Examples

Here is one example for get you started:

class Query(graphene.ObjectType):
    hello = graphene.String(description='A typical hello world')
    ping = graphene.String(description='Ping someone',
                           to=graphene.String())

    def resolve_hello(self, args, info):
        return 'World'

    def resolve_ping(self, args, info):
        return 'Pinging {}'.format(args.get('to'))

schema = graphene.Schema(query=Query)

Then Querying graphene.Schema is as simple as:

query = '''
    query SayHello {
      hello
      ping(to:"peter")
    }
'''
result = schema.execute(query)

If you want to learn even more, you can also check the following examples:

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.4.2.tar.gz (28.8 kB view details)

Uploaded Source

File details

Details for the file graphene-0.4.2.tar.gz.

File metadata

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

File hashes

Hashes for graphene-0.4.2.tar.gz
Algorithm Hash digest
SHA256 2a42f8d2c726737604fb3b3fd8d43884a481e852e0881bf025c2ca7b9f049007
MD5 d5d5e361a832b6f8c30e930e34a9ca75
BLAKE2b-256 3b3b389b517597de69bc3fd27b66e0e5ccd1f6f52cb241ddb1f79fdffed1d91c

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