8000 Make README a bit clearer · graphql-python/graphql-core@07c3a08 · GitHub
[go: up one dir, main page]

Skip to content

Commit 07c3a08

Browse files
committed
Make README a bit clearer
1 parent 36bb3ee commit 07c3a08

File tree

1 file changed

+14
-12
lines changed

1 file changed

+14
-12
lines changed

README.md

Lines changed: 14 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# GraphQL-core-next
22

3-
GraphQL-core-next is a Python port of [GraphQL.js](https://github.com/graphql/graphql-js),
3+
GraphQL-core-next is a Python 3.6+ port of [GraphQL.js](https://github.com/graphql/graphql-js),
44
the JavaScript reference implementation for [GraphQL](https://graphql.org/),
55
a query language for APIs created by Facebook.
66

@@ -165,16 +165,17 @@ GraphQL-core-next tries to reproduce the code of the reference implementation
165165
GraphQL.js in Python as closely as possible and to stay up-to-date with
166166
the latest development of GraphQL.js.
167167

168-
It has been created as an alternative to
168+
It has been created as an alternative and potential successor to
169169
[GraphQL-core](https://github.com/graphql-python/graphql-core),
170-
a prior work by Syrus Akbary, which was based on an older version of
171-
GraphQL.js and targeted older Python versions. Some parts of the code base
172-
of GraphQL.js have been inspired by GraphQL-core or directly taken over with
173-
only slight modifications, but most of the code base has been re-implemented
174-
from scratch, replicating the latest code in GraphQL.js and adding type hints.
175-
Recently, GraphQL-core has also been modernized, but its focus is primarily
176-
to serve as as a solid base library for [Graphene](http://graphene-python.org/),
177-
a more high-level framework for building GraphQL APIs in Python.
170+
a prior work by Syrus Akbary, based on an older version of GraphQL.js and
171+
also targeting older Python versions. GraphQL-core also serves as as the
172+
foundation for [Graphene](http://graphene-python.org/), a more high-level
173+
framework for building GraphQL APIs in Python. Some parts of GraphQL-core-next
174+
have been inspired by GraphQL-core or directly taken over with only slight
175+
modifications, but most of the code has been re-implemented from scratch,
176+
replicating the latest code in GraphQL.js very closely and adding type hints
177+
for Python. Though GraphQL-core has also been updated and modernized to some
178+
extend, it might be replaced by GraphQL-core-next in the future.
178179

179180
Design goals for the GraphQL-core-next library are:
180181

@@ -188,10 +189,11 @@ Design goals for the GraphQL-core-next library are:
188189

189190
Some restrictions (mostly in line with the design goals):
190191

191-
* requires Python >= 3.6
192-
* does not support a few deprecated methods and options of GraphQL.js
192+
* requires Python 3.6 or 3.7
193+
* does not support some already deprecated methods and options of GraphQL.js
193194
* supports asynchronous operations only via async.io
194195
* does not support additional executors and middleware like GraphQL-core
196+
(we are considering adding middleware later though)
195197
* the benchmarks have not yet been ported to Python
196198

197199

0 commit comments

Comments
 (0)
0