From ce7492b5aef1770e7082a0be453d7a16a25ac6ce Mon Sep 17 00:00:00 2001 From: Firas Kafri <3097061+firaskafri@users.noreply.github.com> Date: Thu, 4 May 2023 23:46:15 +0300 Subject: [PATCH] Delete README.rst --- README.rst | 122 ----------------------------------------------------- 1 file changed, 122 deletions(-) delete mode 100644 README.rst diff --git a/README.rst b/README.rst deleted file mode 100644 index f8aa205..0000000 --- a/README.rst +++ /dev/null @@ -1,122 +0,0 @@ -Please read -`UPGRADE-v2.0.md `__ -to learn how to upgrade to Graphene ``2.0``. - --------------- - -|Graphene Logo| Graphene-Django |Build Status| |PyPI version| |Coverage Status| -=============================================================================== - -A `Django `__ integration for -`Graphene `__. - - -Documentation -------------- - -`Visit the documentation to get started! `__ - -Quickstart ----------- - -For installing graphene, just run this command in your shell - -.. code:: bash - - pip install "graphene-django>=3" - -Settings -~~~~~~~~ - -.. code:: python - - INSTALLED_APPS = ( - # ... - 'graphene_django', - ) - - GRAPHENE = { - 'SCHEMA': 'app.schema.schema' # Where your Graphene schema lives - } - -Urls -~~~~ - -We need to set up a ``GraphQL`` endpoint in our Django app, so we can -serve the queries. - -.. code:: python - - from django.conf.urls import url - from graphene_django.views import GraphQLView - - urlpatterns = [ - # ... - url(r'^graphql$', GraphQLView.as_view(graphiql=True)), - ] - -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 - import graphene - - 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=Query) - -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 ------------- - -See `CONTRIBUTING.md `__. - -.. |Graphene Logo| image:: http://graphene-python.org/favicon.png -.. |Build Status| image:: https://github.com/graphql-python/graphene-django/workflows/Tests/badge.svg - :target: https://github.com/graphql-python/graphene-django/actions -.. |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