Pre-release

This release is a pre-release and may not be stable for production use.

You are in the next unreleased version of Graphene-sqlalchemy (1.0.dev). Please read UPGRADE-v1.0.md to learn how to upgrade.

Graphene-SQLAlchemy

A SQLAlchemy integration for Graphene.

Installation

For instaling graphene, just run this command in your shell

pip install "graphene-sqlalchemy>=1.0.dev"

Examples

Here is a simple SQLAlchemy model:

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:

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=Query)

Then you can simply query the schema:

query = '''
    query {
      users {
        name,
        lastName
      }
    }
'''
result = schema.execute(query, context_value={'session': db_session})

To learn more check out the following examples:

Full example: Flask SQLAlchemy example

Contributing

After cloning this repo, ensure dependencies are installed by running:

python setup.py install

After developing, the full test suite can be evaluated by running:

python setup.py test # Use --pytest-args="-v -s" for verbose mode

Metadata

Release files for graphene-sqlalchemy 1.0.dev20160920000001

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for graphene-sqlalchemy 1.0.dev20160920000001
File	Size	Uploaded	Provenance
graphene-sqlalchemy-1.0.dev20160920000001.tar.gz	10.1 kB	Sep 21, 2016	Without provenance	Details

Release files / graphene-sqlalchemy-1.0.dev20160920000001.tar.gz

Download URL	graphene-sqlalchemy-1.0.dev20160920000001.tar.gz
Size	10.1 kB
Tags	Source
SHA-256 checksum How to use checksums	`a88409f5834f0558c3a526c4f34c2284402d47ea4400ade4fed80452eb9dd870`
BLAKE2b-256 checksum How to use checksums	`6dff8dff3122224d141ba4211cfe24be4eacd686a3b169e36046c4a60c929410`
Upload date	Sep 21, 2016
Uploaded using Trusted Publishing? What is trusted publishing?	No

Security for graphene-sqlalchemy 1.0.dev20160920000001

Report project as malware

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

No provenance found

None of the files in this release were uploaded with provenance metadata.

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.

To learn more about protecting yourself from malicious actors, visit our package security documentation.