graphql-python/graphene
1
1
Fork 0
mirror of https://github.com/graphql-python/graphene.git synced 2024-11-22 17:46:57 +03:00
Code Issues Packages Projects Releases Wiki Activity

Updated READMES

Browse Source
This commit is contained in:
Syrus Akbary 2015-10-30 00:01:44 -07:00
parent 6fe2750c6b
commit a682ef8bc3
2 changed files with 22 additions and 12 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

12
README.md
View File

@ -2,11 +2,14 @@
Graphene is a Python library for building GraphQL schemas/types fast and easily. Graphene is a Python library for building GraphQL schemas/types fast and easily.
* **Easy to use:** It maps the models/fields to internal GraphQL objects without effort. * **Easy to use:** Graphene helps you use GraphQL in Python without effort.
* **Relay:** Graphene has builtin support for Relay * **Relay:** Graphene has builtin support for Relay
* **Django:** Automatic *Django model* mapping to Graphene Types. *See an [example Django](http://github.com/graphql-python/swapi-graphene) implementation* * **Django:** Automatic *Django model* mapping to Graphene Types. *See an [example Django](http://github.com/graphql-python/swapi-graphene) implementation*
*But, what is supported in this Python version?* **Everything**: Interfaces, ObjectTypes, Mutations and Relay (Nodes, Connections and Mutations).
## Installation ## Installation
For instaling graphene, just run this command in your shell For instaling graphene, just run this command in your shell
@ -49,10 +52,11 @@ query = '''
result = schema.execute(query) result = schema.execute(query)
``` ```
If you want to learn even more, you can also check the following examples: If you want to learn even more, you can also check the following [examples](examples/):
* Relay Schema: [Starwars Relay example](examples/starwars_relay) * **Basic Schema**: [Starwars example](examples/starwars)
* Django: [Starwars Django example](examples/starwars_django) * **Relay Schema**: [Starwars Relay example](examples/starwars_relay)
* **Django model mapping**: [Starwars Django example](examples/starwars_django)
## Contributing ## Contributing

22
README.rst
View File

@ -2,13 +2,16 @@
========================================================================================================= =========================================================================================================
Graphene is a Python library for building GraphQL schemas/types fast and Graphene is a Python library for building GraphQL schemas/types fast and
easily. \* **Easy to use:** It maps the models/fields to internal easily. \* **Easy to use:** Graphene helps you use GraphQL in Python
GraphQL objects without effort. \* **Relay:** Graphene has builtin without effort. \* **Relay:** Graphene has builtin support for Relay \*
support for Relay \* **Django:** Automatic *Django model* mapping to **Django:** Automatic *Django model* mapping to Graphene Types. *See an
Graphene Types. *See an `example `example Django <http://github.com/graphql-python/swapi-graphene>`__
Django <http://github.com/graphql-python/swapi-graphene>`__
implementation* implementation*
*But, what is supported in this Python version?* **Everything**:
Interfaces, ObjectTypes, Mutations and Relay (Nodes, Connections and
Mutations).
Installation Installation
------------ ------------
@ -53,10 +56,13 @@ Then Querying ``graphene.Schema`` is as simple as:
result = schema.execute(query) result = schema.execute(query)
If you want to learn even more, you can also check the following If you want to learn even more, you can also check the following
examples: `examples <examples/>`__:
- Relay Schema: `Starwars Relay example <examples/starwars_relay>`__ - **Basic Schema**: `Starwars example <examples/starwars>`__
- Django: `Starwars Django example <examples/starwars_django>`__ - **Relay Schema**: `Starwars Relay
example <examples/starwars_relay>`__
- **Django model mapping**: `Starwars Django
example <examples/starwars_django>`__
Contributing Contributing
------------ ------------