From a2a7f6615b746f96cd2bc27bcc7c8906e750f222 Mon Sep 17 00:00:00 2001 From: Syrus Akbary Date: Sat, 6 Aug 2016 16:10:25 -0700 Subject: [PATCH] Added documentation. --- README.rst | 49 +++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 49 insertions(+) diff --git a/README.rst b/README.rst index e69de29b..7d75e015 100644 --- a/README.rst +++ b/README.rst @@ -0,0 +1,49 @@ +GQL +=== + +This is a GraphQL client for Python. Plays nicely with ``graphene``, +``graphql-core``, ``graphql-js`` and any other GraphQL implementation +compatible with the spec. + +GQL architecture is inspired by ``React-Relay`` and ``Apollo-Client``. + +|travis| |pypi| |coveralls| + +Installation +------------ + +:: + + $ pip install gql + +Usage +----- + +The example below shows how you can execute queries against a local +schema. + +.. code:: python + + from gql import gql, Client + + client = Client(schema=schema) + query = gql(''' + { + hello + } + ''') + + client.execute(query) + +License +------- + +`MIT +License `__ + +.. |travis| image:: https://img.shields.io/travis/graphql-python/gql.svg?style=flat + :target: https://travis-ci.org/graphql-python/gql +.. |pypi| image:: https://img.shields.io/pypi/v/gql.svg?style=flat + :target: https://pypi.python.org/pypi/gql +.. |coveralls| image:: https://coveralls.io/repos/graphql-python/gql/badge.svg?branch=master&service=github + :target: https://coveralls.io/github/graphql-python/gql?branch=master