GraphQL framework for Python
Go to file
Syrus Akbary a3c3be26f4 Merge pull request #410 from docmatrix/feature/source-method
Allow class methods to be used as a field source
2017-01-28 11:37:51 -08:00
bin Improved PEP8 syntax and order imports 2016-01-02 21:19:15 +01:00
docs Fixed mutations Input code. Fixed #398 2017-01-10 15:45:32 +01:00
examples Added context example 2016-11-11 19:40:23 -08:00
graphene Allow class methods to be used as a field source 2017-01-27 21:17:49 +00:00
.coveragerc Fixed coverage 2016-09-08 22:26:31 -07:00
.editorconfig Adding .editorconfig to help enforce whitespace rules 2015-12-05 09:02:15 +00:00
.gitignore Added default value for default resolver. 2016-09-21 09:34:29 +01:00
.travis.yml Added PyPI upload based on travis 2016-11-14 21:29:24 -08:00
LICENSE Updated license 2016-09-17 22:04:03 -07:00
MANIFEST.in Exclude tests directories in graphene package 2016-05-12 00:12:00 -07:00
README.md small grammar fix on readme 2017-01-22 17:46:31 +09:00
README.rst small grammar fix on readme 2017-01-22 17:46:31 +09:00
setup.cfg Fixed coverage 2016-09-08 22:26:31 -07:00
setup.py Updated external dependencies 2016-12-01 21:18:37 -08:00
tox.ini Updated external dependencies 2016-12-01 21:18:37 -08:00
UPGRADE-v1.0.md Removed executor and middleware from the Schema. 2016-09-20 00:04:41 -07:00

Please read UPGRADE-v1.0.md to learn how to upgrade to Graphene 1.0.


Graphene Logo Graphene Build Status PyPI version Coverage Status

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
  • Data agnostic: Graphene supports any kind of data source: SQL (Django, SQLAlchemy), NoSQL, custom Python objects, etc. We believe that by providing a complete API you could plug Graphene anywhere your data lives and make your data available through GraphQL.

Integrations

Graphene has multiple integrations with different frameworks:

integration Package
Django graphene-django
SQLAlchemy graphene-sqlalchemy
Google App Engine graphene-gae
Peewee In progress (Tracking Issue)

Installation

For instaling graphene, just run this command in your shell

pip install "graphene>=1.0"

1.0 Upgrade Guide

Please read UPGRADE-v1.0.md to learn how to upgrade.

Examples

Here is one example for you to get started:

class Query(graphene.ObjectType):
    hello = graphene.String(description='A typical hello world')

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

schema = graphene.Schema(query=Query)

Then Querying graphene.Schema is as simple as:

query = '''
    query SayHello {
      hello
    }
'''
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

Documentation

The documentation is generated using the excellent Sphinx and a custom theme.

The documentation dependencies are installed by running:

cd docs
pip install -r requirements.txt

Then to produce a HTML version of the documentation:

make html