diff --git a/README.rst b/README.rst new file mode 100644 index 0000000..c4a5532 --- /dev/null +++ b/README.rst @@ -0,0 +1,96 @@ +You are in the ``next`` unreleased version of Graphene-Django +(``1.0.dev``). Please read +`UPGRADE-v1.0.md `__ +to learn how to upgrade. + +-------------- + +|Graphene Logo| Graphene-Django |Build Status| |PyPI version| |Coverage Status| +=============================================================================== + +A `Django `__ integration for +`Graphene `__. + +Installation +------------ + +For instaling graphene, just run this command in your shell + +.. code:: bash + + pip install "graphene-django>=1.0.dev" + +Examples +-------- + +Here is a simple Django model: + +.. code:: python + + from django.db import models + + class UserModel(models.Model): + name = models.CharField(max_length=100) + last_name = models.CharField(max_length=100) + +To create a GraphQL schema for it you simply have to write the +following: + +.. code:: python + + from graphene_django import DjangoObjectType + + class User(DjangoObjectType): + class Meta: + model = UserModel + + class Query(graphene.ObjectType): + users = graphene.List(User) + + @graphene.resolve_only_args + def resolve_users(self): + return UserModel.objects.all() + + schema = graphene.Schema(query=QueryRoot) + +Then you can simply query the schema: + +.. code:: python + + query = ''' + query { + users { + name, + lastName + } + } + ''' + result = schema.execute(query) + +To learn more check out the following `examples `__: + +- **Schema with Filtering**: `Cookbook example `__ +- **Relay Schema**: `Starwars Relay example `__ + +Contributing +------------ + +After cloning this repo, 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/graphql-python/graphene-django.svg?branch=master + :target: https://travis-ci.org/graphql-python/graphene-django +.. |PyPI version| image:: https://badge.fury.io/py/graphene-django.svg + :target: https://badge.fury.io/py/graphene-django +.. |Coverage Status| image:: https://coveralls.io/repos/graphql-python/graphene-django/badge.svg?branch=master&service=github + :target: https://coveralls.io/github/graphql-python/graphene-django?branch=master diff --git a/setup.py b/setup.py index d4ecb4b..816ed7c 100644 --- a/setup.py +++ b/setup.py @@ -2,10 +2,10 @@ from setuptools import find_packages, setup setup( name='graphene-django', - version='1.0.dev20160910000001', + version='1.0.dev20160917000001', description='Graphene Django integration', - # long_description=open('README.rst').read(), + long_description=open('README.rst').read(), url='https://github.com/graphql-python/graphene-django',