GraphQL framework for Python
Go to file
2018-06-08 22:13:45 -07:00
bin Improved PEP8 syntax and order imports 2016-01-02 21:19:15 +01:00
docs Run pre-commit on all files 2018-06-08 22:08:58 -07:00
examples Add isort precommit hook & run on all files (#743) 2018-05-28 19:18:54 +01:00
graphene Add isort precommit hook & run on all files (#743) 2018-05-28 19:18:54 +01:00
.coveragerc Fixed coverage 2016-09-08 22:26:31 -07:00
.editorconfig Add isort precommit hook & run on all files (#743) 2018-05-28 19:18:54 +01:00
.gitignore Update .gitignore for pytest 3.4+ 2018-02-08 01:31:12 +02:00
.isort.cfg Add isort precommit hook & run on all files (#743) 2018-05-28 19:18:54 +01:00
.pre-commit-config.yaml Run pre-commit autoupdate 2018-06-08 22:13:45 -07:00
.travis.yml Run pre-commit on all files 2018-06-08 22:08:58 -07:00
LICENSE Updated license 2016-09-17 22:04:03 -07:00
MANIFEST.in Include license in manifest for source bundles 2017-05-22 16:18:33 -07:00
mypy.ini Added mypy static checking 2017-08-07 20:48:26 -07:00
README.md Updated docs to use stable version of Graphene 2.0 2017-10-26 00:22:59 -07:00
README.rst Updated docs 2017-07-27 03:05:58 -07:00
setup.cfg Added support for wheel distributions. Fixed #505 2017-07-31 22:30:13 -07:00
setup.py Add isort precommit hook & run on all files (#743) 2018-05-28 19:18:54 +01:00
tox.ini Fix: Make tox stop failing (#741) 2018-05-28 21:25:15 +01:00
UPGRADE-v1.0.md Update UPGRADE-v1.0.md 2017-05-03 10:58:56 -04:00
UPGRADE-v2.0.md Add isort precommit hook & run on all files (#743) 2018-05-28 19:18:54 +01:00

Please read UPGRADE-v2.0.md to learn how to upgrade to Graphene 2.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)

Also, Graphene is fully compatible with the GraphQL spec, working seamlessly with all GraphQL clients, such as Relay, Apollo and gql.

Installation

For instaling graphene, just run this command in your shell

pip install "graphene>=2.0"

2.0 Upgrade Guide

Please read UPGRADE-v2.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, 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:

pip install -e ".[test]"

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

py.test graphene --cov=graphene --benchmark-skip # Use -v -s for verbose mode

You can also run the benchmarks with:

py.test graphene --benchmark-only

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