Skip to content

Commit c18d147

Browse files
CitoCito
committed
Start removing the "next" suffix in the documentation
1 parent a8ec2a9 commit c18d147

File tree

12 files changed

+65
-85
lines changed

12 files changed

+65
-85
lines changed

Diff for: ‎LICENSE

+2-2
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
11
MIT License
22

33
Copyright (c) GraphQL Contributors (GraphQL.js)
4-
Copyright (c) Syrus Akbary (GraphQL-core)
5-
Copyright (c) Christoph Zwerschke (GraphQL-core-next)
4+
Copyright (c) Syrus Akbary (GraphQL-core 2)
5+
Copyright (c) Christoph Zwerschke (GraphQL-core 3)
66

77
Permission is hereby granted, free of charge, to any person obtaining a copy
88
of this software and associated documentation files (the "Software"), to deal

Diff for: ‎README.md

+27-37
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
1-
# GraphQL-core-next
1+
# GraphQL-core 3
22

3-
GraphQL-core-next is a Python 3.6+ port of [GraphQL.js](https://github.com/graphql/graphql-js),
3+
GraphQL-core 3 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

@@ -12,31 +12,22 @@ a query language for APIs created by Facebook.
1212
[![Python 3 Status](https://pyup.io/repos/github/graphql-python/graphql-core-next/python-3-shield.svg)](https://pyup.io/repos/github/graphql-python/graphql-core-next/)
1313
[![Code Style](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/ambv/black)
1414

15-
The current version 3.0.0a0 of GraphQL-core-next is up-to-date with GraphQL.js version
16-
14.4.0. All parts of the API are covered by an extensive test suite of currently 1882
17-
unit tests.
15+
The current version 3.0.0a0 of GraphQL-core is up-to-date
16+
with GraphQL.js version 14.4.0.
1817

19-
Development will be continued with the new distribution name GraphQL-core from now on.
20-
21-
22-
## GraphQL-core-next is now GraphQL-core 3
23-
24-
GraphQL-core-next has been discontinued as a separate Python distribution.
25-
Instead, it is now released as GraphQL-core version 3 and newer, replacing
26-
the existing GraphQL-core distribution. The old versions of GraphQL-core,
27-
which also support older Python versions, are still available.
18+
All parts of the API are covered by an extensive test suite
19+
of currently 1882 unit tests.
2820

2921

3022
## Documentation
3123

32-
A more detailed documentation for GraphQL-core-next can be found at
24+
A more detailed documentation for GraphQL-core 3 can be found at
3325
[graphql-core-next.readthedocs.io](https://graphql-core-next.readthedocs.io/).
3426

3527
The documentation for GraphQL.js can be found at [graphql.org/graphql-js/](https://graphql.org/graphql-js/).
3628

3729
The documentation for GraphQL itself can be found at [graphql.org](https://graphql.org/).
3830

39-
4031
There will be also [blog articles](https://cito.github.io/tags/graphql/) with more usage
4132
examples.
4233

@@ -53,19 +44,19 @@ README and the corresponding tests in parallel.
5344

5445
## Installation
5546

56-
GraphQL-core-next can be installed from PyPI using the built-in pip command:
47+
GraphQL-core 3 can be installed from PyPI using the built-in pip command:
5748

58-
python -m pip install graphql-core-next
49+
python -m pip install "graphql-core>=3"
5950

6051
Alternatively, you can also use [pipenv](https://docs.pipenv.org/) for installation in a
6152
virtual environment:
6253

63-
pipenv install graphql-core-next
54+
pipenv install "graphql-core>=3"
6455

6556

6657
## Usage
6758

68-
GraphQL-core-next provides two important capabilities: building a type schema, and
59+
GraphQL-core provides two important capabilities: building a type schema, and
6960
serving queries against that type schema.
7061

7162
First, build a GraphQL type schema which maps to your code base:
@@ -176,25 +167,25 @@ finally:
176167

177168
## Goals and restrictions
178169

179-
GraphQL-core-next tries to reproduce the code of the reference implementation GraphQL.js
170+
GraphQL-core tries to reproduce the code of the reference implementation GraphQL.js
180171
in Python as closely as possible and to stay up-to-date with the latest development of
181172
GraphQL.js.
182173

183-
It has been created as a modern alternative to
184-
[GraphQL-core](https://github.com/graphql-python/graphql-core), a prior work
185-
by Syrus Akbary, based on an older version of GraphQL.js and also targeting
186-
older Python versions. Some parts of GraphQL-core-next have been inspired by
187-
GraphQL-core or directly taken over with only slight modifications, but most of the code
188-
has been re-implemented from scratch, replicating the latest code in GraphQL.js very
189-
closely and adding type hints for Python.
174+
GraphQL-core 3 (formerly known as GraphQL-core-next) has been created as a modern
175+
alternative to [GraphQL-core 2](https://github.com/graphql-python/graphql-core),
176+
a prior work by Syrus Akbary, based on an older version of GraphQL.js and also
177+
targeting older Python versions. Some parts of GraphQL-core 3 have been inspired by
178+
GraphQL-core 2 or directly taken over with only slight modifications, but most of the
179+
code has been re-implemented from scratch, replicating the latest code in GraphQL.js
180+
very closely and adding type hints for Python.
190181

191-
Design goals for the GraphQL-core-next library are:
182+
Design goals for the GraphQL-core 3 library are:
192183

193184
* to be a simple, cruft-free, state-of-the-art implementation of GraphQL using current
194185
library and language versions
195186
* to be very close to the GraphQL.js reference implementation, while still using a
196187
Pythonic API and code style
197-
* to make extensive use of Python type hints, similar to how GraphQL.js makes use of Flow
188+
* to make extensive use of Python type hints, similar to how GraphQL.js makes uses Flow
198189
* to use [black](https://github.com/ambv/black) for automatic code formatting
199190
* to replicate the complete Mocha-based test suite of GraphQL.js using
200191
[pytest](https://docs.pytest.org/)
@@ -216,10 +207,9 @@ Some restrictions (mostly in line with the design goals):
216207
also been created by Syrus Akbary, who meanwhile has handed over the maintenance
217208
and future development to members of the GraphQL-Python community.
218209

219-
The current version 2 of Graphene is using Graphql-core as core library for much of
220-
the heavy lifting. Note that Graphene 2 is not compatible with GraphQL-core-next.
221-
The new version 3 of Graphene however is planned to use GraphQL-core-next instead of
222-
GraphQL-core, and GraphQL-core-next will be renamed to Graphql-core 3.
210+
The current version 2 of Graphene is using Graphql-core 2 as core library for much of
211+
the heavy lifting. Note that Graphene 2 is not compatible with GraphQL-core 3.
212+
The new version 3 of Graphene will use GraphQL-core 3 instead of GraphQL-core 2.
223213

224214
* [Ariadne](https://github.com/mirumee/ariadne) is a Python library for implementing
225215
GraphQL servers using schema-first approach created by Mirumee Software.
@@ -239,9 +229,9 @@ Changes are tracked as
239229

240230
## Credits and history
241231

242-
The GraphQL-core-next library
232+
The GraphQL-core 3 library
243233
* has been created and is maintained by Christoph Zwerschke
244-
* uses ideas and code from GraphQL-core, a prior work by Syrus Akbary
234+
* uses ideas and code from GraphQL-core 2, a prior work by Syrus Akbary
245235
* is a Python port of GraphQL.js which has been developed by Lee Byron and others
246236
at Facebook, Inc. and is now maintained
247237
by the [GraphQL foundation](https://gql.foundation/join/)
@@ -255,6 +245,6 @@ and ported to many different programming languages.
255245

256246
## License
257247

258-
GraphQL-core-next is
248+
GraphQL-core 3 is
259249
[MIT-licensed](https://github.com/graphql-python/graphql-core-next/blob/master/LICENSE),
260250
just like GraphQL.js.

Diff for: ‎docs/Makefile

+4-4
Original file line numberDiff line numberDiff line change
@@ -91,9 +91,9 @@ qthelp:
9191
@echo
9292
@echo "Build finished; now you can run "qcollectiongenerator" with the" \
9393
".qhcp project file in $(BUILDDIR)/qthelp, like this:"
94-
@echo "# qcollectiongenerator $(BUILDDIR)/qthelp/GraphQL-core-next.qhcp"
94+
@echo "# qcollectiongenerator $(BUILDDIR)/qthelp/GraphQL-core.qhcp"
9595
@echo "To view the help file:"
96-
@echo "# assistant -collectionFile $(BUILDDIR)/qthelp/GraphQL-core-next.qhc"
96+
@echo "# assistant -collectionFile $(BUILDDIR)/qthelp/GraphQL-core.qhc"
9797

9898
.PHONY: applehelp
9999
applehelp:
@@ -110,8 +110,8 @@ devhelp:
110110
@echo
111111
@echo "Build finished."
112112
@echo "To view the help file:"
113-
@echo "# mkdir -p $$HOME/.local/share/devhelp/GraphQL-core-next"
114-
@echo "# ln -s $(BUILDDIR)/devhelp $$HOME/.local/share/devhelp/GraphQL-core-next"
113+
@echo "# mkdir -p $$HOME/.local/share/devhelp/GraphQL-core"
114+
@echo "# ln -s $(BUILDDIR)/devhelp $$HOME/.local/share/devhelp/GraphQL-core"
115115
@echo "# devhelp"
116116

117117
.PHONY: epub

Diff for: ‎docs/conf.py

+8-8
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# -*- coding: utf-8 -*-
22
#
3-
# GraphQL-core-next documentation build configuration file, created by
3+
# GraphQL-core 3 documentation build configuration file, created by
44
# sphinx-quickstart on Thu Jun 21 16:28:30 2018.
55
#
66
# This file is execfile()d with the current directory set to its
@@ -50,7 +50,7 @@
5050
master_doc = 'index'
5151

5252
# General information about the project.
53-
project = u'GraphQL-core-next'
53+
project = u'GraphQL-core 3'
5454
copyright = u'2019, Christoph Zwerschke'
5555
author = u'Christoph Zwerschke'
5656

@@ -134,7 +134,7 @@
134134
# The name for this set of Sphinx documents.
135135
# "<project> v<release> documentation" by default.
136136
#
137-
# html_title = u'GraphQL-core-next v1.0.0'
137+
# html_title = u'GraphQL-core v3.0.0'
138138

139139
# A shorter title for the navigation bar. Default is the same as html_title.
140140
#
@@ -234,7 +234,7 @@
234234
# html_search_scorer = 'scorer.js'
235235

236236
# Output file base name for HTML help builder.
237-
htmlhelp_basename = 'GraphQL-core-next-doc'
237+
htmlhelp_basename = 'GraphQL-core-3-doc'
238238

239239
# -- Options for LaTeX output ---------------------------------------------
240240

@@ -260,7 +260,7 @@
260260
# (source start file, target name, title,
261261
# author, documentclass [howto, manual, or own class]).
262262
latex_documents = [
263-
(master_doc, 'GraphQL-core-next.tex', u'GraphQL-core-next Documentation',
263+
(master_doc, 'GraphQL-core-3.tex', u'GraphQL-core 3 Documentation',
264264
u'Christoph Zwerschke', 'manual'),
265265
]
266266

@@ -296,7 +296,7 @@
296296
# One entry per manual page. List of tuples
297297
# (source start file, name, description, authors, manual section).
298298
man_pages = [
299-
(master_doc, 'graphql-core-next', u'GraphQL-core-next Documentation',
299+
(master_doc, 'graphql-core', u'GraphQL-core 3 Documentation',
300300
[author], 1)
301301
]
302302

@@ -311,8 +311,8 @@
311311
# (source start file, target name, title, author,
312312
# dir menu entry, description, category)
313313
texinfo_documents = [
314-
(master_doc, 'GraphQL-core-next', u'GraphQL-core-next Documentation',
315-
author, 'GraphQL-core-next', 'One line description of project.',
314+
(master_doc, 'GraphQL-core', u'GraphQL-core 3 Documentation',
315+
author, 'GraphQL-core 3', 'One line description of project.',
316316
'Miscellaneous'),
317317
]
318318

Diff for: ‎docs/index.rst

+2-2
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
1-
Welcome to GraphQL-core-next
2-
============================
1+
Welcome to GraphQL-core 3
2+
=========================
33

44
Contents
55
--------

Diff for: ‎docs/intro.rst

+10-13
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,10 @@
11
Introduction
22
============
33

4-
`GraphQL-core-next`_ is a Python port of `GraphQL.js`_,
4+
`GraphQL-core-3`_ is a Python port of `GraphQL.js`_,
55
the JavaScript reference implementation for GraphQL_,
66
a query language for APIs created by Facebook.
77

8-
.. attention:: GraphQL-core-next has been deprecated.
9-
It is now released as GraphQL-core v3 and newer.
10-
118
`GraphQL`_ consists of three parts:
129

1310
* A type system that you define
@@ -25,22 +22,22 @@ which consists of the following sections:
2522
* Response_
2623

2724
This division into subsections is reflected in the :ref:`sub-packages` of
28-
GraphQL-core-next. Each of these sub-packages implements the aspects specified in
25+
GraphQL-core 3. Each of these sub-packages implements the aspects specified in
2926
one of the sections of the specification.
3027

3128

3229
Getting started
3330
---------------
3431

35-
You can install GraphQL-core-next using pip_::
32+
You can install GraphQL-core 3 using pip_::
3633

37-
pip install graphql-core-next
34+
pip install "graphql-core>=3"
3835

39-
You can also install GraphQL-core-next with pipenv_, if you prefer that::
36+
You can also install GraphQL-core 3 with pipenv_, if you prefer that::
4037

41-
pipenv install graphql-core-next
38+
pipenv install "graphql-core>=3"
4239

43-
Now you can start using GraphQL-core-next by importing from the top-level
40+
Now you can start using GraphQL-core 3 by importing from the top-level
4441
:mod:`graphql` package. Nearly everything defined in the sub-packages
4542
can also be imported directly from the top-level package.
4643

@@ -82,13 +79,13 @@ This will yield the following output::
8279
Reporting Issues and Contributing
8380
---------------------------------
8481

85-
Please visit the `GitHub repository of GraphQL-core-next`_ if you're interested
82+
Please visit the `GitHub repository of GraphQL-core 3`_ if you're interested
8683
in the current development or want to report issues or send pull requests.
8784

8885
.. _GraphQL: https://graphql.org/
8986
.. _GraphQl.js: https://github.com/graphql/graphql-js
90-
.. _GraphQl-core-next: https://github.com/graphql-python/graphql-core-next
91-
.. _GitHub repository of GraphQL-core-next: https://github.com/graphql-python/graphql-core-next
87+
.. _GraphQl-core-3: https://github.com/graphql-python/graphql-core-next
88+
.. _GitHub repository of GraphQL-core 3: https://github.com/graphql-python/graphql-core-next
9289
.. _Specification for GraphQL: https://facebook.github.io/graphql/
9390
.. _Language: https://facebook.github.io/graphql/draft/#sec-Language
9491
.. _Type System: https://facebook.github.io/graphql/draft/#sec-Type-System

Diff for: ‎docs/make.bat

+2-2
Original file line numberDiff line numberDiff line change
@@ -129,9 +129,9 @@ if "%1" == "qthelp" (
129129
echo.
130130
echo.Build finished; now you can run "qcollectiongenerator" with the ^
131131
.qhcp project file in %BUILDDIR%/qthelp, like this:
132-
echo.^> qcollectiongenerator %BUILDDIR%\qthelp\GraphQL-core-next.qhcp
132+
echo.^> qcollectiongenerator %BUILDDIR%\qthelp\GraphQL-core.qhcp
133133
echo.To view the help file:
134-
echo.^> assistant -collectionFile %BUILDDIR%\qthelp\GraphQL-core-next.ghc
134+
echo.^> assistant -collectionFile %BUILDDIR%\qthelp\GraphQL-core.ghc
135135
goto end
136136
)
137137

Diff for: ‎docs/usage/other.rst

+2-2
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@ Other Usages
1919
GraphQL-core-next provides many more low-level functions that can be used to work with
2020
GraphQL schemas and queries. We encourage you to explore the contents of the various
2121
:ref:`sub-packages`, particularly :mod:`graphql.utilities`, and to look into the source
22-
code and tests of `GraphQL-core-next`_ in order to find all the functionality that is
22+
code and tests of `GraphQL-core 3`_ in order to find all the functionality that is
2323
provided and understand it in detail.
2424

25-
.. _GraphQL-core-next: https://github.com/graphql-python/graphql-core-next
25+
.. _GraphQL-core 3: https://github.com/graphql-python/graphql-core-next

Diff for: ‎pyproject.toml

+2-2
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
11
[tool.poetry]
2-
name = "graphql-core-next"
2+
name = "graphql-core"
33
version = "3.0.0a0"
44
description = """
5-
GraphQL-core-next is a Python port of GraphQL.js,
5+
GraphQL-core is a Python port of GraphQL.js,
66
the JavaScript reference implementation for GraphQL."""
77
licese="MIT"
88
authors = [

Diff for: ‎src/graphql/__init__.py

+5-5
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,9 @@
1-
"""GraphQL-core-next
1+
"""GraphQL-core
22
33
The primary :mod:`graphql` package includes everything you need to define a GraphQL
44
schema and fulfill GraphQL requests.
55
6-
GraphQL-core-next provides a reference implementation for the GraphQL specification
6+
GraphQL-core provides a reference implementation for the GraphQL specification
77
but is also a useful utility for operating on GraphQL files and building sophisticated
88
tools.
99
@@ -25,7 +25,7 @@
2525
from graphql import parse
2626
from graphql.language import parse
2727
28-
The sub-packages of GraphQL-core-next are:
28+
The sub-packages of GraphQL-core 3 are:
2929
3030
- :mod:`graphql.language`: Parse and operate on the GraphQL language.
3131
- :mod:`graphql.type`: Define GraphQL types and schema.
@@ -37,7 +37,7 @@
3737
- :mod:`graphql.subscription`: Subscribe to data updates.
3838
"""
3939

40-
# The GraphQL-core-next and GraphQL.js version info.
40+
# The GraphQL-core 3 and GraphQL.js version info.
4141

4242
from .version import version, version_info, version_js, version_info_js
4343

@@ -386,7 +386,7 @@
386386
find_dangerous_changes,
387387
)
388388

389-
# The GraphQL-core-next version info.
389+
# The GraphQL-core version info.
390390
__version__ = version
391391
__version_info__ = version_info
392392

Diff for: ‎src/graphql/utilities/build_client_schema.py

+1-1
Original file line numberDiff line numberDiff line change
@@ -43,7 +43,7 @@ def build_client_schema(
4343
"""Build a GraphQLSchema for use by client tools.
4444
4545
Given the result of a client running the introspection query, creates and returns
46-
a GraphQLSchema instance which can be then used with all GraphQL-core-next tools,
46+
a GraphQLSchema instance which can be then used with all GraphQL-core 3 tools,
4747
but cannot be used to execute a query, as introspection does not represent the
4848
"resolver", "parse" or "serialize" functions or any other server-internal
4949
mechanisms.

0 commit comments

Comments
 (0)