Skip to main content

Relay implementation for Python

Project description

This is a library to allow the easy creation of Relay-compliant servers using the GraphQL-py reference implementation of a GraphQL server.

Note: The code is a __exact__ port of the original `graphql-relay js implementation`_ from Facebook

Build Status Coverage Status

Getting Started

A basic understanding of GraphQL and of the GraphQL-py implementation is needed to provide context for this library.

An overview of GraphQL in general is available in the README for the Specification for GraphQL.

This library is designed to work with the the GraphQL-py reference implementation of a GraphQL server.

An overview of the functionality that a Relay-compliant GraphQL server should provide is in the GraphQL Relay Specification on the Relay website. That overview describes a simple set of examples that exist as tests in this repository. A good way to get started with this repository is to walk through that documentation and the corresponding tests in this library together.

Using Relay Library for GraphQL-py

Install Relay Library for GraphQL-py

pip install git+https://github.com/dittos/graphql-py.git # Last version of graphql-py
pip install graphql-relay

When building a schema for GraphQL-py, the provided library functions can be used to simplify the creation of Relay patterns.

Project details


Download files

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

Source Distribution

graphql-relay-0.1.tar.gz (5.4 kB view hashes)

Uploaded Source

Supported by

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