Isolated Graphene SQLAlchemy in new package

Author: syrusakbary

.coveragerc

@@ -0,0 +1,2 @@
+[run]
+omit = */tests/*

.gitignore

@@ -0,0 +1,67 @@
+# Created by https://www.gitignore.io
+
+### Python ###
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[cod]
+
+# C extensions
+*.so
+
+# Distribution / packaging
+.Python
+env/
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+*.egg-info/
+.installed.cfg
+*.egg
+
+# PyInstaller
+#  Usually these files are written by a python script from a template
+#  before PyInstaller builds the exe, so as to inject date/other infos into it.
+*.manifest
+*.spec
+
+# Installer logs
+pip-log.txt
+pip-delete-this-directory.txt
+
+# Unit test / coverage reports
+htmlcov/
+.tox/
+.coverage
+.coverage.*
+.cache
+nosetests.xml
+coverage.xml
+*,cover
+
+# Translations
+*.mo
+*.pot
+
+# Django stuff:
+*.log
+
+# Sphinx documentation
+docs/_build/
+
+# PyBuilder
+target/
+
+# PyCharm
+.idea
+
+# Databases
+*.sqlite3
+.vscode

.travis.yml

@@ -0,0 +1,52 @@
+language: python
+sudo: false
+python:
+- 2.7
+- 3.4
+- 3.5
+- pypy
+before_install:
+  - |
+      if [ "$TRAVIS_PYTHON_VERSION" = "pypy" ]; then
+        export PYENV_ROOT="$HOME/.pyenv"
+        if [ -f "$PYENV_ROOT/bin/pyenv" ]; then
+          cd "$PYENV_ROOT" && git pull
+        else
+          rm -rf "$PYENV_ROOT" && git clone --depth 1 https://github.com/yyuu/pyenv.git "$PYENV_ROOT"
+        fi
+        export PYPY_VERSION="4.0.1"
+        "$PYENV_ROOT/bin/pyenv" install "pypy-$PYPY_VERSION"
+        virtualenv --python="$PYENV_ROOT/versions/pypy-$PYPY_VERSION/bin/python" "$HOME/virtualenvs/pypy-$PYPY_VERSION"
+        source "$HOME/virtualenvs/pypy-$PYPY_VERSION/bin/activate"
+      fi
+install:
+- |
+  if [ "$TEST_TYPE" = build ]; then
+    pip install pytest==3.0.2 pytest-cov pytest-benchmark coveralls six mock
+    pip install -e .
+    python setup.py develop
+  elif [ "$TEST_TYPE" = lint ]; then
+    pip install flake8
+  fi
+script:
+- |
+  if [ "$TEST_TYPE" = lint ]; then
+    echo "Checking Python code lint."
+    flake8 graphene_sqlalchemy
+    exit
+  elif [ "$TEST_TYPE" = build ]; then
+    py.test --cov=graphene_sqlalchemy graphene_sqlalchemy examples
+  fi
+after_success:
+- |
+  if [ "$TEST_TYPE" = build ]; then
+      coveralls
+  fi
+env:
+  matrix:
+  - TEST_TYPE=build
+matrix:
+  fast_finish: true
+  include:
+  - python: '2.7'
+    env: TEST_TYPE=lint

README.md

@@ -0,0 +1,88 @@
+You are in the `next` unreleased version of Graphene-sqlalchemy (`1.0.dev`).
+Please read [UPGRADE-v1.0.md](https://github.com/graphql-python/graphene/blob/master/UPGRADE-v1.0.md) to learn how to upgrade.
+
+---
+
+# ![Graphene Logo](http://graphene-python.org/favicon.png) Graphene-SQLAlchemy [![Build Status](https://travis-ci.org/graphql-python/graphene-sqlalchemy.svg?branch=master)](https://travis-ci.org/graphql-python/graphene-sqlalchemy) [![PyPI version](https://badge.fury.io/py/graphene-sqlalchemy.svg)](https://badge.fury.io/py/graphene-sqlalchemy) [![Coverage Status](https://coveralls.io/repos/graphql-python/graphene-sqlalchemy/badge.svg?branch=master&service=github)](https://coveralls.io/github/graphql-python/graphene-sqlalchemy?branch=master)
+
+
+A [SQLAlchemy](http://www.sqlalchemy.org/) integration for [Graphene](http://graphene-python.org/).
+
+## Installation
+
+For instaling graphene, just run this command in your shell
+
+```bash
+pip install "graphene-sqlalchemy>=1.0.dev"
+```
+
+## Examples
+
+Here is a simple SQLAlchemy model:
+
+```python
+from sqlalchemy import Column, Integer, String
+from sqlalchemy.orm import backref, relationship
+
+from sqlalchemy.ext.declarative import declarative_base
+
+Base = declarative_base()
+
+class UserModel(Base):
+    __tablename__ = 'department'
+    id = Column(Integer, primary_key=True)
+    name = Column(String)
+    last_name = Column(String)
+```
+
+To create a GraphQL schema for it you simply have to write the following:
+
+```python
+from graphene_sqlalchemy import SQLAlchemyObjectType
+
+class User(SQLAlchemyObjectType):
+    class Meta:
+        model = UserModel
+
+class Query(graphene.ObjectType):
+    users = graphene.List(User)
+
+    def resolve_users(self, args, context, info):
+        query = User.get_query(context) # SQLAlchemy query
+        return query.all()
+
+schema = graphene.Schema(query=QueryRoot)
+```
+
+Then you can simply query the schema:
+
+```python
+query = '''
+    query {
+      users {
+        name,
+        lastName
+      }
+    }
+'''
+result = schema.execute(query, context_value={'session': db_session})
+```
+
+To learn more check out the following [examples](examples/):
+
+* **Full example**: [Flask SQLAlchemy example](examples/flask_sqlalchemy)
+
+
+## Contributing
+
+After cloning this repo, ensure dependencies are installed by running:
+
+```sh
+python setup.py install
+```
+
+After developing, the full test suite can be evaluated by running:
+
+```sh
+python setup.py test # Use --pytest-args="-v -s" for verbose mode
+```

bin/autolinter

@@ -0,0 +1,7 @@
+#!/bin/bash
+
+# Install the required scripts with
+# pip install autoflake autopep8 isort
+autoflake ./examples/ ./graphene_sqlalchemy/ -r --remove-unused-variables --remove-all-unused-imports --in-place
+autopep8 ./examples/ ./graphene_sqlalchemy/ -r --in-place --experimental --aggressive --max-line-length 120
+isort -rc ./examples/ ./graphene_sqlalchemy/

bin/convert_documentation

@@ -0,0 +1,3 @@
+#!/bin/bash
+
+pandoc README.md --from markdown --to rst -s -o README.rst

examples/flask_sqlalchemy/README.md

@@ -0,0 +1,50 @@
+Example Flask+SQLAlchemy Project
+================================
+
+This example project demos integration between Graphene, Flask and SQLAlchemy.
+The project contains two models, one named `Department` and another
+named `Employee`.
+
+Getting started
+---------------
+
+First you'll need to get the source of the project. Do this by cloning the
+whole Graphene repository:
+
+```bash
+# Get the example project code
+git clone https://github.com/graphql-python/graphene.git
+cd graphene/examples/flask_sqlalchemy
+```
+
+It is good idea (but not required) to create a virtual environment
+for this project. We'll do this using
+[virtualenv](http://docs.python-guide.org/en/latest/dev/virtualenvs/)
+to keep things simple,
+but you may also find something like
+[virtualenvwrapper](https://virtualenvwrapper.readthedocs.org/en/latest/)
+to be useful:
+
+```bash
+# Create a virtualenv in which we can install the dependencies
+virtualenv env
+source env/bin/activate
+```
+
+Now we can install our dependencies:
+
+```bash
+pip install -r requirements.txt
+```
+
+Now the following command will setup the database, and start the server:
+
+```bash
+./app.py
+
+```
+
+
+Now head on over to
+[http://127.0.0.1:5000/graphiql](http://127.0.0.1:5000/graphiql)
+and run some queries!

examples/flask_sqlalchemy/__init__.py

@@ -0,0 +1,40 @@
+from flask import Flask
+
+from database import db_session, init_db
+from flask_graphql import GraphQLView
+from schema import schema
+
+app = Flask(__name__)
+app.debug = True
+
+default_query = '''
+{
+  allEmployees {
+    edges {
+      node {
+        id,
+        name,
+        department {
+          id,
+          name
+        },
+        role {
+          id,
+          name
+        }
+      }
+    }
+  }
+}'''.strip()
+
+
+app.add_url_rule('/graphql', view_func=GraphQLView.as_view('graphql', schema=schema, graphiql=True))
+
+
+@app.teardown_appcontext
+def shutdown_session(exception=None):
+    db_session.remove()
+
+if __name__ == '__main__':
+    init_db()
+    app.run()

examples/flask_sqlalchemy/app.py

@@ -0,0 +1,38 @@
+from sqlalchemy import create_engine
+from sqlalchemy.ext.declarative import declarative_base
+from sqlalchemy.orm import scoped_session, sessionmaker
+
+engine = create_engine('sqlite:///database.sqlite3', convert_unicode=True)
+db_session = scoped_session(sessionmaker(autocommit=False,
+                                         autoflush=False,
+                                         bind=engine))
+Base = declarative_base()
+Base.query = db_session.query_property()
+
+
+def init_db():
+    # import all modules here that might define models so that
+    # they will be registered properly on the metadata.  Otherwise
+    # you will have to import them first before calling init_db()
+    from models import Department, Employee, Role
+    Base.metadata.drop_all(bind=engine)
+    Base.metadata.create_all(bind=engine)
+
+    # Create the fixtures
+    engineering = Department(name='Engineering')
+    db_session.add(engineering)
+    hr = Department(name='Human Resources')
+    db_session.add(hr)
+
+    manager = Role(name='manager')
+    db_session.add(manager)
+    engineer = Role(name='engineer')
+    db_session.add(engineer)
+
+    peter = Employee(name='Peter', department=engineering, role=engineer)
+    db_session.add(peter)
+    roy = Employee(name='Roy', department=engineering, role=engineer)
+    db_session.add(roy)
+    tracy = Employee(name='Tracy', department=hr, role=manager)
+    db_session.add(tracy)
+    db_session.commit()

examples/flask_sqlalchemy/database.py

@@ -0,0 +1,39 @@
+from sqlalchemy import Column, DateTime, ForeignKey, Integer, String, func
+from sqlalchemy.orm import backref, relationship
+
+from database import Base
+
+
+class Department(Base):
+    __tablename__ = 'department'
+    id = Column(Integer, primary_key=True)
+    name = Column(String)
+
+
+class Role(Base):
+    __tablename__ = 'roles'
+    role_id = Column(Integer, primary_key=True)
+    name = Column(String)
+
+
+class Employee(Base):
+    __tablename__ = 'employee'
+    id = Column(Integer, primary_key=True)
+    name = Column(String)
+    # Use default=func.now() to set the default hiring time
+    # of an Employee to be the current time when an
+    # Employee record was created
+    hired_on = Column(DateTime, default=func.now())
+    department_id = Column(Integer, ForeignKey('department.id'))
+    role_id = Column(Integer, ForeignKey('roles.role_id'))
+    # Use cascade='delete,all' to propagate the deletion of a Department onto its Employees
+    department = relationship(
+        Department,
+        backref=backref('employees',
+                        uselist=True,
+                        cascade='delete,all'))
+    role = relationship(
+        Role,
+        backref=backref('roles',
+                        uselist=True,
+                        cascade='delete,all'))