Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/fabienarcellier/spike-graphene-flask

implement a graphql service with graphene
https://github.com/fabienarcellier/spike-graphene-flask

Last synced: 25 days ago
JSON representation

implement a graphql service with graphene

Awesome Lists containing this project

README 

        
## implement a graphql service with graphene



![ci](https://github.com/FabienArcellier/spike-graphene-flask/workflows/ci/badge.svg)



The goal of this spike is to implement GraphQL API based on `graphene`.



* [GraphQL in Python Made Easy](https://graphene-python.org/)

* [Build a Super Simple GraphQL Server in Flask with Graphene](https://www.youtube.com/watch?v=oQc7DC3srNM)

* [flask-graphql](https://github.com/graphql-python/flask-graphql)



**Conclusion : I don't plan using graphene as graphql engine**



* Testability of the system is a problem (see part 4). The graphql server and the business code layer are stick together.



## Getting started



### 1. I check I can use graphene as local api solver from the cli



```bash

python -m graphene_spike.cli graphene_cli

```



### 2. Usage : Use web application developped in flask



```bash

python -m graphene_spike.cli graphene_webapp

```



```bash

curl -XPOST http://localhost:5000/ -H "Content-Type: application/json" -d '{ hello(name: "GraphQL", age: 25) }'

```



### 3. Documentation : Fetch the documentation in UI for API exploration



* Altair doesn't load the documentation, even if the query is done

* [graphiql](https://github.com/graphql/graphiql) is embedded with automatic documentation witg ``flask_graphql``



### 4. Testability : Write acceptance tests to validate non regression of API



* write end to end test in [test_query](acceptances/test_query.py)



The support of dependency injection to ensure testability requires heavy trick (injection through contexe) : https://github.com/graphql-python/graphene/issues/837.

The extension `Flask-graphql` doesn't allow that easily. The context is already used to forward the `request` instance from `Flask`.

Another option is to inject the dependency container through a singleton (`very crap`).



`Schema` take a class instead of an instance ... :(((((



### 5. Performance : Scalability on PaaS environment



Not evaluated, there is an overhead of 80ms in regards of Flask (100ms instead of 20ms). I am not

confident with my evaluation here, it's just observation.



### 6. Support of Subscription



Subscription is not well integrated due to limit of `WSGI` protocol of Flask and Django. I didn't try

to implement this feature.



## The latest version



You can find the latest version to ...



```bash

git clone [email protected]:FabienArcellier/spike-graphene-flask.git

```



## Developper guideline



### Add a dependency



Write the dependency in ``setup.py``. As it's the distribution standard for pypi,

I prefer to keep ``setup.py`` as single source of truth.



I encourage avoiding using instruction as ``pipenv install requests`` to register

a new library. You would have to write your dependency in both ``setup.py`` and ``Pipfile``.



### Install development environment



Use make to instanciate a python virtual environment in ./venv and install the

python dependencies.



```bash

make install_requirements_dev

```



### Update release dependencies



Use make to instanciate a python virtual environment in ./venv and freeze

dependencies version on requirement.txt.



```bash

make update_requirements

```



### Activate the python environment



When you setup the requirements, a `venv` directory on python 3 is created.

To activate the venv, you have to execute :



```bash

make venv

source venv/bin/activate

```



### Run the linter and the unit tests



Before commit or send a pull request, you have to execute `pylint` to check the syntax

of your code and run the unit tests to validate the behavior.



```bash

make lint

make tests

```



## Contributors



* Fabien Arcellier



## License



MIT License



Copyright (c) 2018 Fabien Arcellier



Permission is hereby granted, free of charge, to any person obtaining a copy

of this software and associated documentation files (the "Software"), to deal

in the Software without restriction, including without limitation the rights

to use, copy, modify, merge, publish, distribute, sublicense, and/or sell

copies of the Software, and to permit persons to whom the Software is

furnished to do so, subject to the following conditions:



The above copyright notice and this permission notice shall be included in all

copies or substantial portions of the Software.



THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR

IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,

FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE

AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER

LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,

OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE

SOFTWARE.