Skip to main content
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 Logo Graphene Build Status PyPI version Coverage Status

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, 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:

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.dev20170802065539

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.dev20170802065539
File Size Uploaded Provenance
graphene-2.0.dev20170802065539.tar.gz 39.6 kB Without provenance Details

Built distribution (wheel)

Table of built distributions (wheels) for graphene 2.0.dev20170802065539
File Interpreter ABI Platform
graphene-2.0.dev20170802065539-py2.py3-none-any.whl Python 2, Python 3 none any Details

Total release size: 141.6 kB

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

Download URL graphene-2.0.dev20170802065539.tar.gz
Size 39.6 kB
Tags Source
SHA-256 checksum
How to use checksums
5166ee46bc101554b506fb7429aea367dcf7258faea1442fad84bd66a4db3056
BLAKE2b-256 checksum
How to use checksums
ed537e486f3384d4462f0fade621631da3c531e93c48d1c97e945cf1cfccfea4
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No

Release files / graphene-2.0.dev20170802065539-py2.py3-none-any.whl

Download URL graphene-2.0.dev20170802065539-py2.py3-none-any.whl
Size 102.0 kB
Tags Python 2 Python 3
SHA-256 checksum
How to use checksums
7c210517eefb79827d92b94e096de627b7364f9cde8c5cfdda50bc2dd30e87fa
BLAKE2b-256 checksum
How to use checksums
6d11a705bb809ae281c1c6908a5edb75cd345e3c9f12a5c567a54b8d912fdde8
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No

Security for graphene 2.0.dev20170802065539

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.

Release history Release notifications | RSS feed

0.1.6

0.0.1

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page