Skip to content

Commit a2a7f66

Browse files
committed
Added documentation.
1 parent 8fd06d3 commit a2a7f66

File tree

1 file changed

+49
-0
lines changed

1 file changed

+49
-0
lines changed

README.rst

Lines changed: 49 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,49 @@
1+
GQL
2+
===
3+
4+
This is a GraphQL client for Python. Plays nicely with ``graphene``,
5+
``graphql-core``, ``graphql-js`` and any other GraphQL implementation
6+
compatible with the spec.
7+
8+
GQL architecture is inspired by ``React-Relay`` and ``Apollo-Client``.
9+
10+
|travis| |pypi| |coveralls|
11+
12+
Installation
13+
------------
14+
15+
::
16+
17+
$ pip install gql
18+
19+
Usage
20+
-----
21+
22+
The example below shows how you can execute queries against a local
23+
schema.
24+
25+
.. code:: python
26+
27+
from gql import gql, Client
28+
29+
client = Client(schema=schema)
30+
query = gql('''
31+
{
32+
hello
33+
}
34+
''')
35+
36+
client.execute(query)
37+
38+
License
39+
-------
40+
41+
`MIT
42+
License <https://github.com/graphql-python/gql/blob/master/LICENSE>`__
43+
44+
.. |travis| image:: https://img.shields.io/travis/graphql-python/gql.svg?style=flat
45+
:target: https://travis-ci.org/graphql-python/gql
46+
.. |pypi| image:: https://img.shields.io/pypi/v/gql.svg?style=flat
47+
:target: https://pypi.python.org/pypi/gql
48+
.. |coveralls| image:: https://coveralls.io/repos/graphql-python/gql/badge.svg?branch=master&service=github
49+
:target: https://coveralls.io/github/graphql-python/gql?branch=master

0 commit comments

Comments
 (0)