Skip to main content

GraphQL Framework for Python

Project description

We are looking for contributors! Please check the ROADMAP to see how you can help ������


Graphene Logo Graphene Build Status PyPI version Coverage Status

Introduction

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:

Documentation

Documentation and links to additional resources are available at https://docs.graphene-python.org/en/latest/

Contributing

After cloning this repo, create a virtualenv and ensure dependencies are installed by running:

virtualenv venv
source venv/bin/activate
pip install -e ".[test]"

Well-written tests and maintaining good test coverage is important to this project. While developing, run new and existing tests with:

py.test graphene/relay/tests/test_node.py # Single file
py.test graphene/relay # All tests in directory

Add the -s flag if you have introduced breakpoints into the code for debugging. Add the -v (“verbose”) flag to get more detailed test output. For even more detailed output, use -vv. Check out the pytest documentation for more options and test running controls.

You can also run the benchmarks with:

py.test graphene --benchmark-only

Graphene supports several versions of Python. To make sure that changes do not break compatibility with any of those versions, we use tox to create virtualenvs for each Python version and run tests with that version. To run against all Python versions defined in the tox.ini config file, just run:

tox

If you wish to run against a specific version defined in the tox.ini file:

tox -e py36

Tox can only use whatever versions of Python are installed on your system. When you create a pull request, Travis will also be running the same tests and report the results, so there is no need for potential contributors to try to install every single version of Python on their own system ahead of time. We appreciate opening issues and pull requests to make graphene even more stable & useful!

Building Documentation

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

An HTML version of the documentation is produced by running:

make docs

Project details


Release history Release notifications | RSS feed

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

graphene-3.0b0.tar.gz (35.0 kB view details)

Uploaded Source

Built Distribution

graphene-3.0b0-py2.py3-none-any.whl (97.5 kB view details)

Uploaded Python 2 Python 3

File details

Details for the file graphene-3.0b0.tar.gz.

File metadata

  • Download URL: graphene-3.0b0.tar.gz
  • Upload date:
  • Size: 35.0 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.1.1 pkginfo/1.5.0.1 requests/2.23.0 setuptools/45.2.0 requests-toolbelt/0.9.1 tqdm/4.43.0 CPython/3.7.1

File hashes

Hashes for graphene-3.0b0.tar.gz
Algorithm Hash digest
SHA256 76e8b40925a282cfaf21c99701478e4f1b368b49bcf6f53a43d9b5a5b5fbb44b
MD5 6d1fedb2af8e1268ff74f2f437774abb
BLAKE2b-256 b2bf443536b73accfbee250c94be3c7f28841cde5ec57b36b30c6c01b89a48b5

See more details on using hashes here.

File details

Details for the file graphene-3.0b0-py2.py3-none-any.whl.

File metadata

  • Download URL: graphene-3.0b0-py2.py3-none-any.whl
  • Upload date:
  • Size: 97.5 kB
  • Tags: Python 2, Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.1.1 pkginfo/1.5.0.1 requests/2.23.0 setuptools/45.2.0 requests-toolbelt/0.9.1 tqdm/4.43.0 CPython/3.7.1

File hashes

Hashes for graphene-3.0b0-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 70b2ef3a359c3d46d166d75791a396a305ecfadf8f1d14e9a2634147f3737567
MD5 d296ef18d06b51255d0e1a54511fd0e5
BLAKE2b-256 9e2925c613d5bc1c4e5a00ae327fd38cd3991db5a2248d379c9e3bed1fdd4800

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page