mirror of
https://github.com/graphql-python/graphene.git
synced 2024-11-22 09:36:44 +03:00
GraphQL framework for Python
bin | ||
docs | ||
examples | ||
graphene | ||
.coveragerc | ||
.editorconfig | ||
.gitignore | ||
.travis.yml | ||
LICENSE | ||
MANIFEST.in | ||
README.md | ||
README.rst | ||
setup.cfg | ||
setup.py | ||
tox.ini | ||
UPGRADE-v1.0.md |
You are in the next
unreleased version of Graphene (1.0.dev
).
Please read UPGRADE-v1.0.md to learn how to upgrade.
Graphene
Graphene is a Python library for building GraphQL schemas/types fast and easily.
- Easy to use: Graphene helps you use GraphQL in Python without effort.
- Relay: Graphene has builtin support for Relay
- Data agnostic: Graphene supports any kind of data source: SQL (Django, SQLAlchemy), NoSQL, custom Python objects, etc. We believe that by providing a complete API you could plug Graphene anywhere your data lives and make your data available through GraphQL.
Integrations
Graphene has multiple integrations with different frameworks:
integration | Package |
---|---|
Django | graphene-django |
SQLAlchemy | graphene-sqlalchemy |
Google App Engine | graphene-gae |
Peewee | In progress (Tracking Issue) |
Installation
For instaling graphene, just run this command in your shell
pip install "graphene>=1.0.dev"
1.0 Upgrade Guide
Please read UPGRADE-v1.0.md to learn how to upgrade.
Examples
Here is one example for get you started:
class Query(graphene.ObjectType):
hello = graphene.String(description='A typical hello world')
def resolve_hello(self, args, context, info):
return 'World'
schema = graphene.Schema(query=Query)
Then Querying graphene.Schema
is as simple as:
query = '''
query SayHello {
hello
}
'''
result = schema.execute(query)
If you want to learn even more, you can also check the following examples:
- Basic Schema: Starwars example
- Relay Schema: Starwars Relay example
Contributing
After cloning this repo, ensure dependencies are installed by running:
python setup.py install
After developing, the full test suite can be evaluated by running:
python setup.py test # Use --pytest-args="-v -s" for verbose mode