Skip to content

Commit 0b04c9e

Browse files
author
Marco Paolini
committed
Update install documentation
1 parent 51db9ba commit 0b04c9e

File tree

1 file changed

+18
-10
lines changed

1 file changed

+18
-10
lines changed

README.rst

Lines changed: 18 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -11,20 +11,25 @@ Still **EXPERIMENTAL**
1111
Installing
1212
----------
1313

14-
Prerequisites:
14+
Precompiled wheels are usually available on github https://github.com/elastic-coders/py-graphqlparser/releases/
1515

16-
- Install ``cython``
17-
- Download and build ``libgraphqlparser``
16+
Make sure you pick the right wheel for your platform and python version, then install them using pip::
17+
18+
pip install https://github.com/elastic-coders/py-graphqlparser/releases/download/v0.0.3/graphqlparser-0.0.3-cp27-none-linux_x86_64.whl
1819

1920

20-
Install using pip
21+
Installing from source is a bit more complex. The main steps are
2122

23+
- Install ``cython``
24+
- Download and build ``libgraphqlparser``
2225
- set an env var ``$GRAPHQL_HOME`` to the folder where libgraphqlparser is
23-
- ``LDFLAGS="-L$GRAPHQL_HOME" CFLAGS="-I$GRAPHQL_HOME/c -I$GRAPHQL_HOME" pip install graphqlparser``
26+
- compile with::
2427

28+
LDFLAGS="-L$GRAPHQL_HOME" CFLAGS="-I$GRAPHQL_HOME/c -I$GRAPHQL_HOME" pip install graphqlparser
2529

26-
Building from source
27-
--------------------
30+
31+
Building from source checkout
32+
-----------------------------
2833

2934
Needed to rebuild the generate cython files from the libgraphql AST
3035

@@ -34,9 +39,13 @@ Needed to rebuild the generate cython files from the libgraphql AST
3439
- generate source code with ``python ast/build_ast.py``
3540
- you can now switch to python 3
3641
- install ``cython``
37-
- run ``LDFLAGS="-L./libgraphqlparser" CFLAGS="-Ilibgraphqlparser/c -Ilibgraphqlparser" python setup.py build_ext``
42+
- run::
43+
44+
LDFLAGS="-L./libgraphqlparser" CFLAGS="-Ilibgraphqlparser/c -Ilibgraphqlparser" python setup.py build_extx
45+
46+
47+
To create a wheel distribution:
3848

39-
To package with wheel:
4049
- install wheel: ``pip install wheel``
4150
- create wheelhouse ``mkdir .wheelhouse``
4251
- build with ``pip wheel --wheel-dir=.wheelhouse .``
@@ -60,5 +69,4 @@ Known issues
6069
TODO
6170
----
6271

63-
- make wheels available on github
6472
- build more wheel packages for linux 32 bit and other platforms

0 commit comments

Comments
 (0)