graphene

Pre-release

This release is a pre-release and may not be stable for production use.

Please read UPGRADE-v2.0.md to learn how to upgrade to Graphene 2.0.

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)

Also, Graphene is fully compatible with the GraphQL spec, working seamlessly with all GraphQL clients, such as Relay, Apollo and gql.

Installation

For instaling graphene, just run this command in your shell

pip install "graphene>=2.0"

2.0 Upgrade Guide

Please read UPGRADE-v2.0.md to learn how to upgrade.

Examples

Here is one example for you to get started:

class Query(graphene.ObjectType):
    hello = graphene.String(description='A typical hello world')

    def resolve_hello(self):
        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:

pip install -e ".[test]"

After developing, the full test suite can be evaluated by running:

py.test graphene --cov=graphene --benchmark-skip # Use -v -s for verbose mode

You can also run the benchmarks with:

py.test graphene --benchmark-only

Documentation

The documentation is generated using the excellent Sphinx and a custom theme.

The documentation dependencies are installed by running:

cd docs
pip install -r requirements.txt

Then to produce a HTML version of the documentation:

make html

Metadata

Release files for graphene 2.0.dev20170727061432

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for graphene 2.0.dev20170727061432
File	Size	Uploaded	Provenance
graphene-2.0.dev20170727061432.tar.gz	40.5 kB	Jul 27, 2017	Without provenance	Details

Release files / graphene-2.0.dev20170727061432.tar.gz

Download URL	graphene-2.0.dev20170727061432.tar.gz
Size	40.5 kB
Tags	Source
SHA-256 checksum How to use checksums	`fa3a5480687a870fe1abc526eaba7d88562aaffabfe90b71a469106c86067ec8`
BLAKE2b-256 checksum How to use checksums	`ab3e7b61e764a7a6af9c8a5c4d9c31748a2a3b3e7019acdcad158254ee359475`
Upload date	Jul 27, 2017
Uploaded using Trusted Publishing? What is trusted publishing?	No

Security for graphene 2.0.dev20170727061432

Report project as malware

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

No provenance found

None of the files in this release were uploaded with provenance metadata.

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.

To learn more about protecting yourself from malicious actors, visit our package security documentation.