Metadata-Version: 1.2
Name: graphene-mongo
Version: 0.2.12
Summary: Graphene Mongoengine integration
Home-page: https://github.com/graphql-python/graphene-mongo
Author: Abaw Chen
Author-email: abaw.chen@gmail.com
License: MIT
Description: .. image:: https://travis-ci.org/graphql-python/graphene-mongo.svg?branch=master
            :target: https://travis-ci.org/graphql-python/graphene-mongo
        .. image:: https://coveralls.io/repos/github/graphql-python/graphene-mongo/badge.svg?branch=master
            :target: https://coveralls.io/github/graphql-python/graphene-mongo?branch=master
        .. image:: https://badge.fury.io/py/graphene-mongo.svg
            :target: https://badge.fury.io/py/graphene-mongo
        .. image:: https://img.shields.io/pypi/pyversions/graphene-mongo.svg
            :target: https://pypi.python.org/pypi/graphene-mongo/
        
        Graphene-Mongo
        ==============
        
        A `Mongoengine <https://mongoengine-odm.readthedocs.io/>`__ integration for `Graphene <http://graphene-python.org/>`__.
        
        Installation
        ------------
        
        For installing graphene-mongo, just run this command in your shell
        
        .. code:: bash
        
            pip install graphene-mongo
        
        Examples
        --------
        
        Here is a simple Mongoengine model as `models.py`:
        
        .. code:: python
        
            from mongoengine import Document
            from mongoengine.fields import StringField
        
            class User(Document):
                meta = {'collection': 'user'}
                first_name = StringField(required=True)
                last_name = StringField(required=True)
        
        
        To create a GraphQL schema for it you simply have to write the following:
        
        .. code:: python
        
            import graphene
        
            from graphene_mongo import MongoengineObjectType
        
            from .models import User as UserModel
        
            class User(MongoengineObjectType):
                class Meta:
                    model = UserModel
        
            class Query(graphene.ObjectType):
                users = graphene.List(User)
        
                def resolve_users(self, info):
                    return list(UserModel.objects.all())
        
            schema = graphene.Schema(query=Query)
        
        Then you can simply query the schema:
        
        .. code:: python
        
            query = '''
                query {
                    users {
                        firstName,
                        lastName
                    }
                }
            '''
            result = schema.execute(query)
        
        To learn more check out the `Flask MongoEngine example <https://github.com/graphql-python/graphene-mongo/tree/master/examples/flask_mongoengine>`__
        
        
Keywords: api graphql protocol rest relay graphene mongo mongoengine
Platform: UNKNOWN
Classifier: Development Status :: 4 - Beta
Classifier: Intended Audience :: Developers
Classifier: Topic :: Software Development :: Libraries
Classifier: Programming Language :: Python :: 2.7
Classifier: Programming Language :: Python :: 3.4
Classifier: Programming Language :: Python :: 3.5
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: Implementation :: PyPy
Classifier: License :: OSI Approved :: MIT License
Requires-Python: >=2.7
