Merge pull request #87 from graphql-python/sqlalchemy

Added SQLAlchemy support into graphene 💪

Author: syrusakbary

.travis.yml

@@ -25,6 +25,7 @@ install:
   if [ "$TEST_TYPE" = build ]; then
     pip install --download-cache $HOME/.cache/pip/ pytest pytest-cov coveralls six pytest-django django-filter
     pip install --download-cache $HOME/.cache/pip/ -e .[django]
+    pip install --download-cache $HOME/.cache/pip/ -e .[sqlalchemy]
     pip install django==$DJANGO_VERSION
     python setup.py develop
   elif [ "$TEST_TYPE" = build_website ]; then

README.md

@@ -7,6 +7,7 @@
 - **Relay:** Graphene has builtin support for Relay
 - **Django:** Automatic *Django model* mapping to Graphene Types. Check a fully working [Django](http://github.com/graphql-python/swapi-graphene) implementation
 
+Graphene also supports *SQLAlchemy*!
 
 *What is supported in this Python version?* **Everything**: Interfaces, ObjectTypes, Scalars, Unions and Relay (Nodes, Connections), in addition to queries, mutations and subscriptions.
 
@@ -18,8 +19,10 @@ For instaling graphene, just run this command in your shell
 
 ```bash
 pip install graphene
-# Or in case of need Django model support
+# In case of need Django model support
 pip install graphene[django]
+# Or in case of need SQLAlchemy support
+pip install graphene[sqlalchemy]
 ```
 
 
@@ -59,6 +62,7 @@ If you want to learn even more, you can also check the following [examples](exam
 * **Basic Schema**: [Starwars example](examples/starwars)
 * **Relay Schema**: [Starwars Relay example](examples/starwars_relay)
 * **Django model mapping**: [Starwars Django example](examples/starwars_django)
+* **SQLAlchemy model mapping**: [Flask SQLAlchemy example](examples/flask_sqlalchemy)
 
 
 ## Contributing

README.rst

@@ -12,6 +12,8 @@ building GraphQL schemas/types fast and easily.
    `Django <http://github.com/graphql-python/swapi-graphene>`__
    implementation
 
+Graphene also supports *SQLAlchemy*!
+
 *What is supported in this Python version?* **Everything**: Interfaces,
 ObjectTypes, Scalars, Unions and Relay (Nodes, Connections), in addition
 to queries, mutations and subscriptions.
@@ -27,8 +29,10 @@ For instaling graphene, just run this command in your shell
 .. code:: bash
 
     pip install graphene
-    # Or in case of need Django model support
+    # In case of need Django model support
     pip install graphene[django]
+    # Or in case of need SQLAlchemy support
+    pip install graphene[sqlalchemy]
 
 Examples
 --------
@@ -70,6 +74,8 @@ If you want to learn even more, you can also check the following
    example <examples/starwars_relay>`__
 -  **Django model mapping**: `Starwars Django
    example <examples/starwars_django>`__
+-  **SQLAlchemy model mapping**: `Flask SQLAlchemy
+   example <examples/flask_sqlalchemy>`__
 
 Contributing
 ------------

docs/config.toml

@@ -23,3 +23,10 @@ ga = "UA-12613282-7"
 	  "/docs/django/tutorial/",
 	  "/docs/django/filtering/",
 	]
+
+[docs.sqlalchemy]
+	name = "SQLAlchemy"
+	pages = [
+	  "/docs/sqlalchemy/tutorial/",
+	  "/docs/sqlalchemy/tips/",
+	]

docs/css/graphiql.css

@@ -97,6 +97,7 @@
 }
 
 #graphiql-container .resultWrap {
+  position: relative;
   display: -webkit-flex;
   display:         flex;
   -webkit-flex-direction: column;
@@ -1010,6 +1011,52 @@ span.CodeMirror-selectedtext { background: none; }
   background-position: right bottom;
   width: 100%; height: 100%;
 }
+#graphiql-container .spinner-container {
+  position: absolute;
+  top: 50%;
+  height: 36px;
+  width: 36px;
+  left: 50%;
+  transform: translate(-50%, -50%);
+  z-index: 10;
+}
+
+#graphiql-container .spinner {
+  vertical-align: middle;
+  display: inline-block;
+  height: 24px;
+  width: 24px;
+  position: absolute;
+  -webkit-animation: rotation .6s infinite linear;
+  -moz-animation: rotation .6s infinite linear;
+  -o-animation: rotation .6s infinite linear;
+  animation: rotation .6s infinite linear;
+  border-left: 6px solid rgba(150, 150, 150, .15);
+  border-right: 6px solid rgba(150, 150, 150, .15);
+  border-bottom: 6px solid rgba(150, 150, 150, .15);
+  border-top: 6px solid rgba(150, 150, 150, .8);
+  border-radius: 100%;
+}
+
+@-webkit-keyframes rotation {
+  from { -webkit-transform: rotate(0deg); }
+  to { -webkit-transform: rotate(359deg); }
+}
+
+@-moz-keyframes rotation {
+  from { -moz-transform: rotate(0deg); }
+  to { -moz-transform: rotate(359deg); }
+}
+
+@-o-keyframes rotation {
+  from { -o-transform: rotate(0deg); }
+  to { -o-transform: rotate(359deg); }
+}
+
+@keyframes rotation {
+  from { transform: rotate(0deg); }
+  to { transform: rotate(359deg); }
+}
 .CodeMirror-hints {
   background: white;
   -webkit-box-shadow: 0 1px 3px rgba(0, 0, 0, 0.45);
@@ -1076,4 +1123,4 @@ li.CodeMirror-hint-active {
   border-bottom: solid 1px #c0c0c0;
   border-top: none;
   margin-bottom: -1px;
-}
+}

docs/package.json

@@ -18,7 +18,7 @@
     "es6-promise": "^3.0.2",
     "extract-text-webpack-plugin": "^0.9.1",
     "gatsby": "^0.7.7",
-    "graphiql": "^0.4.2",
+    "graphiql": "^0.4.5",
     "graphql": "^0.4.13",
     "jeet": "^6.1.2",
     "lodash": "^3.10.1",

docs/pages/community.md

@@ -21,6 +21,9 @@ Django integration:
 -   **graphql-django-view**: [Source Code][5] - [PyPI package][6]
 -   **django-graphiql**: [Source Code][7] - [PyPI package][8]
 
+Flask integration:
+-   **graphql-flask**: [Source Code][9] - [PyPI package][10]
+
 ## Other related projects
 
 - [Flask GraphQL Demo](https://github.com/amitsaha/flask-graphql-demo) by [@echorand](https://twitter.com/echorand)
@@ -37,3 +40,5 @@ Django integration:
   [6]: https://pypi.python.org/pypi/graphql-django-view
   [7]: https://github.com/graphql-python/django-graphiql
   [8]: https://pypi.python.org/pypi/django-graphiql
+  [9]: https://github.com/graphql-python/graphql-flask
+  [10]: https://pypi.python.org/pypi/graphql-flask

docs/pages/docs/sqlalchemy/tips.md

@@ -0,0 +1,30 @@
+---
+title: Tips
+description: Tips when SQLAlchemy in Graphene
+---
+
+# Tips
+
+## Querying
+
+For make querying to the database work, there are two alternatives:
+
+* Expose the db session when you create the `graphene.Schema`:
+
+```python
+schema = graphene.Schema(session=session)
+```
+
+* Create a query for the models.
+
+```python
+Base = declarative_base()
+Base.query = db_session.query_property()
+
+class MyModel(Base):
+	# ...
+```
+
+If you don't specify any, the following error will be displayed:
+
+`A query in the model Base or a session in the schema is required for querying.`