Skip to content

Commit 401ba83

Browse files
author
Marco Paolini
committed
Clarify install instructions
1 parent f2dbc2b commit 401ba83

File tree

1 file changed

+14
-8
lines changed

1 file changed

+14
-8
lines changed

README.rst

+14-8
Original file line numberDiff line numberDiff line change
@@ -1,27 +1,29 @@
11
Graphql parser based on libgraphqlparser
22
=========================================
33

4-
Python2.7+ Python3.4+ class-based bindings to libgraphqlparser
4+
Python2.7+ Python3.4+ class-based bindings to libgraphqlparser; just a thin layer on top of ``libgraphqlparser`` C API.
55

66
Still **EXPERIMENTAL**
77

88

99
Installing
1010
----------
1111

12-
Precompiled wheels are usually available on github https://github.com/elastic-coders/py-graphqlparser/releases/
12+
First install ``libgraphqlparser`` following instructions on `libgraphqlparser github page`_ .
1313

14-
Make sure you pick the right wheel for your platform and python version, then install them using pip::
14+
Next you can install ``graphqlparser``. The easiest way is using precompiled wheels which are usually available
15+
on `graphqlparser github releases`_
16+
17+
Pick the right wheel for your platform and python version, then install it using pip::
1518

1619
pip install https://github.com/elastic-coders/py-graphqlparser/releases/download/v0.0.3/graphqlparser-0.0.3-cp27-none-linux_x86_64.whl
1720

1821

19-
Installing from source is a bit more complex. The main steps are
22+
As an alternative you can install ``graphqlparser`` from source distribution:
2023

2124
- Install ``cython``
22-
- Download and build ``libgraphqlparser``
23-
- set an env var ``$GRAPHQL_HOME`` to the folder where libgraphqlparser is
24-
- compile with::
25+
- Set an env var ``$GRAPHQL_HOME`` to the folder where ``libgraphqlparser.so`` and ``Ast.h`` are
26+
- Install ``graphqlparser`` with pip::
2527

2628
LDFLAGS="-L$GRAPHQL_HOME" CFLAGS="-I$GRAPHQL_HOME/c -I$GRAPHQL_HOME" pip install graphqlparser
2729

@@ -73,7 +75,7 @@ Rebuild the generated cython files from the libgraphql AST (usually not needed)
7375
- install ``cython``
7476
- run::
7577

76-
LDFLAGS="-L./libgraphqlparser" CFLAGS="-Ilibgraphqlparser/c -Ilibgraphqlparser" python setup.py build_extx
78+
LDFLAGS="-L./libgraphqlparser" CFLAGS="-Ilibgraphqlparser/c -Ilibgraphqlparser" python setup.py build_ext
7779

7880

7981
To create a wheel distribution:
@@ -96,3 +98,7 @@ TODO
9698
----
9799

98100
- build more wheel packages for linux 32 bit and other platforms
101+
102+
103+
.. _libgraphqlparser github page: https://github.com/graphql/libgraphqlparser
104+
.. _graphqlparser github releases: https://github.com/elastic-coders/py-graphqlparser/releases/

0 commit comments

Comments
 (0)