1
1
# Relay Library for GraphQL Python
2
2
3
- This is a library to allow the easy creation of Relay-compliant servers using
4
- the [ GraphQL Python] ( https://github.com/graphql-python/graphql-core ) reference implementation
5
- of a GraphQL server.
3
+ GraphQL-relay-py is the [ Relay] ( https://relay.dev/ ) library for
4
+ [ GraphQL-core] ( https://github.com/graphql-python/graphql-core ) .
6
5
7
- * Note: The code is a __ exact__ port of the original [ graphql-relay js implementation] ( https://github.com/graphql/graphql-relay-js )
8
- from Facebook*
6
+ It allows the easy creation of Relay-compliant servers using GraphQL-core.
7
+
8
+ GraphQL-relay-py is a Python port of
9
+ [ graphql-relay-js] ( https://github.com/graphql/graphql-relay-js ) ,
10
+ while GraphQL-core is a Python port of
11
+ [ GraphQL.js] ( https://github.com/graphql/graphql-js ) ,
12
+ the reference implementation of GraphQL for JavaScript.
13
+
14
+ Since version 3, GraphQL-relay-py and GraphQL-core support Python 3.6 and above only.
15
+ For older versions of Python, you can use version 2 of these libraries.
9
16
10
17
[ ![ PyPI version] ( https://badge.fury.io/py/graphql-relay.svg )] ( https://badge.fury.io/py/graphql-relay )
11
18
[ ![ Build Status] ( https://travis-ci.org/graphql-python/graphql-relay-py.svg?branch=master )] ( https://travis-ci.org/graphql-python/graphql-relay-py )
@@ -21,15 +28,16 @@ An overview of GraphQL in general is available in the
21
28
[ Specification for GraphQL] ( https://github.com/graphql-python/graphql-core ) .
22
29
23
30
This library is designed to work with the
24
- the [ GraphQL Python] ( https://github.com/graphql-python/graphql-core ) reference implementation
25
- of a GraphQL server.
26
-
27
- An overview of the functionality that a Relay-compliant GraphQL server should
28
- provide is in the [ GraphQL Relay Specification] ( https://facebook.github.io/relay/docs/graphql-relay-specification.html )
29
- on the [ Relay website] ( https://facebook.github.io/relay/ ) . That overview
30
- describes a simple set of examples that exist as [ tests] ( tests ) in this
31
- repository. A good way to get started with this repository is to walk through
32
- that documentation and the corresponding tests in this library together.
31
+ the [ GraphQL-core] ( https://github.com/graphql-python/graphql-core )
32
+ Python reference implementation of a GraphQL server.
33
+
34
+ An overview of the functionality that a Relay-compliant GraphQL server should provide
35
+ is in the [ GraphQL Relay Specification] ( https://facebook.github.io/relay/docs/graphql-relay-specification.html )
36
+ on the [ Relay website] ( https://facebook.github.io/relay/ ) .
37
+ That overview describes a simple set of examples that exist
38
+ as [ tests] ( tests ) in this repository.
39
+ A good way to get started with this repository is to walk through that documentation
40
+ and the corresponding tests in this library together.
33
41
34
42
## Using Relay Library for GraphQL Python (graphql-core-next)
35
43
0 commit comments