File: basic_usage.rst

package info (click to toggle)
python-gql 3.6.0~b4-1
  • links: PTS, VCS
  • area: main
  • in suites: trixie
  • size: 1,824 kB
  • sloc: python: 20,567; makefile: 52
file content (21 lines) | stat: -rw-r--r-- 774 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
.. _basic_usage:

Basic usage
-----------

In order to execute a GraphQL request against a GraphQL API:

* create your gql :ref:`transport <transports>` in order to choose the destination url
  and the protocol used to communicate with it
* create a gql :class:`Client <gql.client.Client>` with the selected transport
* parse a query using :func:`gql <gql.gql>`
* execute the query on the client to get the result

.. literalinclude:: ../code_examples/aiohttp_sync.py

.. warning::

    Please note that this basic example won't work if you have an asyncio event loop running. In some
    python environments (as with Jupyter which uses IPython) an asyncio event loop is created for you.
    In that case you should use instead the :ref:`Async Usage example<async_usage>`.