Skip to content

Commit

Permalink
Start removing the "next" suffix in the documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
Cito committed Jul 14, 2019
1 parent a8ec2a9 commit c18d147
Show file tree
Hide file tree
Showing 12 changed files with 65 additions and 85 deletions.
4 changes: 2 additions & 2 deletions LICENSE
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
MIT License

Copyright (c) GraphQL Contributors (GraphQL.js)
Copyright (c) Syrus Akbary (GraphQL-core)
Copyright (c) Christoph Zwerschke (GraphQL-core-next)
Copyright (c) Syrus Akbary (GraphQL-core 2)
Copyright (c) Christoph Zwerschke (GraphQL-core 3)

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
Expand Down
64 changes: 27 additions & 37 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# GraphQL-core-next
# GraphQL-core 3

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

Expand All @@ -12,31 +12,22 @@ a query language for APIs created by Facebook.
[![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/)
[![Code Style](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/ambv/black)

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

Development will be continued with the new distribution name GraphQL-core from now on.


## GraphQL-core-next is now GraphQL-core 3

GraphQL-core-next has been discontinued as a separate Python distribution.
Instead, it is now released as GraphQL-core version 3 and newer, replacing
the existing GraphQL-core distribution. The old versions of GraphQL-core,
which also support older Python versions, are still available.
All parts of the API are covered by an extensive test suite
of currently 1882 unit tests.


## Documentation

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

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

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


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

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

## Installation

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

python -m pip install graphql-core-next
python -m pip install "graphql-core>=3"

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

pipenv install graphql-core-next
pipenv install "graphql-core>=3"


## Usage

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

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

## Goals and restrictions

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

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

Design goals for the GraphQL-core-next library are:
Design goals for the GraphQL-core 3 library are:

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

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

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

## Credits and history

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

## License

GraphQL-core-next is
GraphQL-core 3 is
[MIT-licensed](https://github.com/graphql-python/graphql-core-next/blob/master/LICENSE),
just like GraphQL.js.
8 changes: 4 additions & 4 deletions docs/Makefile
Original file line number Diff line number Diff line change
Expand Up @@ -91,9 +91,9 @@ qthelp:
@echo
@echo "Build finished; now you can run "qcollectiongenerator" with the" \
".qhcp project file in $(BUILDDIR)/qthelp, like this:"
@echo "# qcollectiongenerator $(BUILDDIR)/qthelp/GraphQL-core-next.qhcp"
@echo "# qcollectiongenerator $(BUILDDIR)/qthelp/GraphQL-core.qhcp"
@echo "To view the help file:"
@echo "# assistant -collectionFile $(BUILDDIR)/qthelp/GraphQL-core-next.qhc"
@echo "# assistant -collectionFile $(BUILDDIR)/qthelp/GraphQL-core.qhc"

.PHONY: applehelp
applehelp:
Expand All @@ -110,8 +110,8 @@ devhelp:
@echo
@echo "Build finished."
@echo "To view the help file:"
@echo "# mkdir -p $$HOME/.local/share/devhelp/GraphQL-core-next"
@echo "# ln -s $(BUILDDIR)/devhelp $$HOME/.local/share/devhelp/GraphQL-core-next"
@echo "# mkdir -p $$HOME/.local/share/devhelp/GraphQL-core"
@echo "# ln -s $(BUILDDIR)/devhelp $$HOME/.local/share/devhelp/GraphQL-core"
@echo "# devhelp"

.PHONY: epub
Expand Down
16 changes: 8 additions & 8 deletions docs/conf.py
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# -*- coding: utf-8 -*-
#
# GraphQL-core-next documentation build configuration file, created by
# GraphQL-core 3 documentation build configuration file, created by
# sphinx-quickstart on Thu Jun 21 16:28:30 2018.
#
# This file is execfile()d with the current directory set to its
Expand Down Expand Up @@ -50,7 +50,7 @@
master_doc = 'index'

# General information about the project.
project = u'GraphQL-core-next'
project = u'GraphQL-core 3'
copyright = u'2019, Christoph Zwerschke'
author = u'Christoph Zwerschke'

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

# A shorter title for the navigation bar. Default is the same as html_title.
#
Expand Down Expand Up @@ -234,7 +234,7 @@
# html_search_scorer = 'scorer.js'

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

# -- Options for LaTeX output ---------------------------------------------

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

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

Expand All @@ -311,8 +311,8 @@
# (source start file, target name, title, author,
# dir menu entry, description, category)
texinfo_documents = [
(master_doc, 'GraphQL-core-next', u'GraphQL-core-next Documentation',
author, 'GraphQL-core-next', 'One line description of project.',
(master_doc, 'GraphQL-core', u'GraphQL-core 3 Documentation',
author, 'GraphQL-core 3', 'One line description of project.',
'Miscellaneous'),
]

Expand Down
4 changes: 2 additions & 2 deletions docs/index.rst
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
Welcome to GraphQL-core-next
============================
Welcome to GraphQL-core 3
=========================

Contents
--------
Expand Down
23 changes: 10 additions & 13 deletions docs/intro.rst
Original file line number Diff line number Diff line change
@@ -1,13 +1,10 @@
Introduction
============

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

.. attention:: GraphQL-core-next has been deprecated.
It is now released as GraphQL-core v3 and newer.

`GraphQL`_ consists of three parts:

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

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


Getting started
---------------

You can install GraphQL-core-next using pip_::
You can install GraphQL-core 3 using pip_::

pip install graphql-core-next
pip install "graphql-core>=3"

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

pipenv install graphql-core-next
pipenv install "graphql-core>=3"

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

Expand Down Expand Up @@ -82,13 +79,13 @@ This will yield the following output::
Reporting Issues and Contributing
---------------------------------

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

.. _GraphQL: https://graphql.org/
.. _GraphQl.js: https://github.com/graphql/graphql-js
.. _GraphQl-core-next: https://github.com/graphql-python/graphql-core-next
.. _GitHub repository of GraphQL-core-next: https://github.com/graphql-python/graphql-core-next
.. _GraphQl-core-3: https://github.com/graphql-python/graphql-core-next
.. _GitHub repository of GraphQL-core 3: https://github.com/graphql-python/graphql-core-next
.. _Specification for GraphQL: https://facebook.github.io/graphql/
.. _Language: https://facebook.github.io/graphql/draft/#sec-Language
.. _Type System: https://facebook.github.io/graphql/draft/#sec-Type-System
Expand Down
4 changes: 2 additions & 2 deletions docs/make.bat
Original file line number Diff line number Diff line change
Expand Up @@ -129,9 +129,9 @@ if "%1" == "qthelp" (
echo.
echo.Build finished; now you can run "qcollectiongenerator" with the ^
.qhcp project file in %BUILDDIR%/qthelp, like this:
echo.^> qcollectiongenerator %BUILDDIR%\qthelp\GraphQL-core-next.qhcp
echo.^> qcollectiongenerator %BUILDDIR%\qthelp\GraphQL-core.qhcp
echo.To view the help file:
echo.^> assistant -collectionFile %BUILDDIR%\qthelp\GraphQL-core-next.ghc
echo.^> assistant -collectionFile %BUILDDIR%\qthelp\GraphQL-core.ghc
goto end
)

Expand Down
4 changes: 2 additions & 2 deletions docs/usage/other.rst
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ Other Usages
GraphQL-core-next provides many more low-level functions that can be used to work with
GraphQL schemas and queries. We encourage you to explore the contents of the various
:ref:`sub-packages`, particularly :mod:`graphql.utilities`, and to look into the source
code and tests of `GraphQL-core-next`_ in order to find all the functionality that is
code and tests of `GraphQL-core 3`_ in order to find all the functionality that is
provided and understand it in detail.

.. _GraphQL-core-next: https://github.com/graphql-python/graphql-core-next
.. _GraphQL-core 3: https://github.com/graphql-python/graphql-core-next
4 changes: 2 additions & 2 deletions pyproject.toml
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
[tool.poetry]
name = "graphql-core-next"
name = "graphql-core"
version = "3.0.0a0"
description = """
GraphQL-core-next is a Python port of GraphQL.js,
GraphQL-core is a Python port of GraphQL.js,
the JavaScript reference implementation for GraphQL."""
licese="MIT"
authors = [
Expand Down
10 changes: 5 additions & 5 deletions src/graphql/__init__.py
Original file line number Diff line number Diff line change
@@ -1,9 +1,9 @@
"""GraphQL-core-next
"""GraphQL-core
The primary :mod:`graphql` package includes everything you need to define a GraphQL
schema and fulfill GraphQL requests.
GraphQL-core-next provides a reference implementation for the GraphQL specification
GraphQL-core provides a reference implementation for the GraphQL specification
but is also a useful utility for operating on GraphQL files and building sophisticated
tools.
Expand All @@ -25,7 +25,7 @@
from graphql import parse
from graphql.language import parse
The sub-packages of GraphQL-core-next are:
The sub-packages of GraphQL-core 3 are:
- :mod:`graphql.language`: Parse and operate on the GraphQL language.
- :mod:`graphql.type`: Define GraphQL types and schema.
Expand All @@ -37,7 +37,7 @@
- :mod:`graphql.subscription`: Subscribe to data updates.
"""

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

from .version import version, version_info, version_js, version_info_js

Expand Down Expand Up @@ -386,7 +386,7 @@
find_dangerous_changes,
)

# The GraphQL-core-next version info.
# The GraphQL-core version info.
__version__ = version
__version_info__ = version_info

Expand Down
2 changes: 1 addition & 1 deletion src/graphql/utilities/build_client_schema.py
Original file line number Diff line number Diff line change
Expand Up @@ -43,7 +43,7 @@ def build_client_schema(
"""Build a GraphQLSchema for use by client tools.
Given the result of a client running the introspection query, creates and returns
a GraphQLSchema instance which can be then used with all GraphQL-core-next tools,
a GraphQLSchema instance which can be then used with all GraphQL-core 3 tools,
but cannot be used to execute a query, as introspection does not represent the
"resolver", "parse" or "serialize" functions or any other server-internal
mechanisms.
Expand Down
Loading

0 comments on commit c18d147

Please sign in to comment.