Metadata-Version: 1.1
Name: graphene-pynamodb
Version: 0.5
Summary: Graphene PynamoDB integration
Home-page: https://github.com/yfilali/graphql-pynamodb
Author: Yacine Filali
Author-email: yfilali@gmail.com
License: MIT
Description: Please read
        `UPGRADE-v1.0.md <https://github.com/graphql-python/graphene/blob/master/UPGRADE-v1.0.md>`__
        to learn how to upgrade to Graphene ``1.0``.
        
        --------------
        
        |Graphene Logo| Graphene-PynamoDB |Build Status| |Coverage Status|
        ==================================================================
        
        A `PynamoDB <http://pynamodb.readthedocs.io/>`__ integration for
        `Graphene <http://graphene-python.org/>`__.
        
        Installation
        ------------
        
        For instaling graphene, just run this command in your shell
        
        .. code:: bash
        
            pip install graphene-pynamodb
        
        Examples
        --------
        
        Here is a simple PynamoDB model:
        
        .. code:: python
        
            from uuid import uuid4
            from pynamodb.attributes import UnicodeAttribute
            from pynamodb.models import Model
        
        
            class User(Model):
                class Meta:
                    table_name = "my_users"
                    host = "http://localhost:8000"
        
                id = UnicodeAttribute(hash_key=True)
                name = UnicodeAttribute(null=False)
        
        
            if not User.exists():
                User.create_table(read_capacity_units=1, write_capacity_units=1, wait=True)
                User(id=str(uuid4()), name="John Snow").save()
                User(id=str(uuid4()), name="Daenerys Targaryen").save()
        
        To create a GraphQL schema for it you simply have to write the
        following:
        
        .. code:: python
        
            import graphene
            from graphene_pynamodb import PynamoObjectType
        
        
            class UserNode(PynamoObjectType):
                class Meta:
                    model = User
                    interfaces = (graphene.Node,)
        
        
            class Query(graphene.ObjectType):
                users = graphene.List(UserNode)
        
                def resolve_users(self, args, context, info):
                    return User.scan()
        
        
            schema = graphene.Schema(query=Query)
        
        Then you can simply query the schema:
        
        .. code:: python
        
            query = '''
                query {
                  users {
                    name
                  }
                }
            '''
            result = schema.execute(query)
        
        To learn more check out the following
        `examples <https://github.com/yfilali/graphql-pynamodb/tree/master/examples/>`__:
        
        -  **Full example**: `Flask PynamoDB
           example <https://github.com/yfilali/graphql-pynamodb/tree/master/examples/flask_pynamodb>`__
        
        Limitations
        -----------
        
        graphene-pynamodb includes a basic implementation of relationships using
        sets. OneToOne and OneToMany relationships are serialized as sets of the
        ids and unserialized lazyly. The limit for an item's size in DynamoDB is
        400KB (see
        http://docs.aws.amazon.com/amazondynamodb/latest/developerguide/Limits.html)
        This means the total "row" size including the serialized relationship
        needs to fit within 400KB so make sure to use this accordingly.
        
        In addition, scan operations on DynamoDB are unsorted by design. This
        means that there is no reliable way to get a paginated result (Cursor
        support) on a root PynamoConnectionField.
        
        This means that if you need to paginate items, it is best to have them
        as a OneToMany relationship inside another Field (usually viewer or
        node).
        
        Contributing
        ------------
        
        After cloning `this
        repo <https://github.com/yfilali/graphql-pynamodb>`__, ensure
        dependencies are installed by running:
        
        .. code:: sh
        
            python setup.py install
        
        After developing, the full test suite can be evaluated by running:
        
        .. code:: sh
        
            python setup.py test # Use --pytest-args="-v -s" for verbose mode
        
        .. |Graphene Logo| image:: http://graphene-python.org/favicon.png
        .. |Build Status| image:: https://travis-ci.org/yfilali/graphql-pynamodb.svg?branch=master
           :target: https://travis-ci.org/yfilali/graphql-pynamodb
        .. |Coverage Status| image:: https://coveralls.io/repos/github/yfilali/graphql-pynamodb/badge.svg?branch=master
           :target: https://coveralls.io/github/yfilali/graphql-pynamodb?branch=master
        
Keywords: api graphql protocol rest relay graphene pynamodb dynamodb
Platform: UNKNOWN
Classifier: Development Status :: 3 - Alpha
Classifier: Intended Audience :: Developers
Classifier: Topic :: Software Development :: Libraries
Classifier: Programming Language :: Python :: 2
Classifier: Programming Language :: Python :: 2.7
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.3
Classifier: Programming Language :: Python :: 3.4
Classifier: Programming Language :: Python :: 3.5
Classifier: Programming Language :: Python :: Implementation :: PyPy
