Skip to content

Commit

Permalink
update readme (#8)
Browse files Browse the repository at this point in the history
  • Loading branch information
ewhauser authored Nov 10, 2018
1 parent ebf1201 commit 1be8511
Showing 1 changed file with 43 additions and 2 deletions.
45 changes: 43 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,47 @@

A project for running [Graphene](http://graphene-python.org/) on top of [Tornado](http://www.tornadoweb.org/) in Python 2 and 3. The codebase is a port of [graphene-django](https://github.com/graphql-python/graphene-django).

# Examples
# Getting started

See the [example](examples/example.py) application for an example on how to create GraphQL handlers in a Tornado project.
Create a Tornado application and add the GraphQL handlers:

```python
import tornado.web
from tornado.ioloop import IOLoop

from graphene_tornado.schema import schema
from graphene_tornado.tornado_graphql_handler import TornadoGraphQLHandler


class ExampleApplication(tornado.web.Application):

def __init__(self):
handlers = [
(r'/graphql', TornadoGraphQLHandler, dict(graphiql=True, schema=schema)),
(r'/graphql/batch', TornadoGraphQLHandler, dict(graphiql=True, schema=schema, batch=True)),
(r'/graphql/graphiql', TornadoGraphQLHandler, dict(graphiql=True, schema=schema))
]
tornado.web.Application.__init__(self, handlers)

if __name__ == '__main__':
app = ExampleApplication()
app.listen(5000)
IOLoop.instance().start()
```

When writing your resolvers, decorate them with either Tornado's `@coroutine` decorator for Python 2.7:

```python
@gen.coroutine
def resolve_foo(self, info):
foo = yield db.get_foo()
raise Return(foo)
```

Or use the `async` / `await` pattern in Python 3:

```python
async def resolve_foo(self, info):
foo = await db.get_foo()
return foo
```

0 comments on commit 1be8511

Please sign in to comment.