From b9b80c016edd1ea72be00d6dd2698be21a8cb875 Mon Sep 17 00:00:00 2001 From: Christoph Zwerschke Date: Sat, 30 Nov 2019 19:52:38 +0100 Subject: [PATCH] Prepare final 3.0.0 release --- .bumpversion.cfg | 2 +- README.md | 6 +++--- docs/conf.py | 34 +++++++++++++++++++++++++++++++++- docs/diffs.rst | 2 +- docs/intro.rst | 8 ++++---- docs/requirements.txt | 2 ++ pyproject.toml | 2 +- src/graphql/version.py | 2 +- 8 files changed, 46 insertions(+), 12 deletions(-) create mode 100644 docs/requirements.txt diff --git a/.bumpversion.cfg b/.bumpversion.cfg index 8be18726..181bd7cd 100644 --- a/.bumpversion.cfg +++ b/.bumpversion.cfg @@ -1,5 +1,5 @@ [bumpversion] -current_version = 3.0.0b1 +current_version = 3.0.0 commit = False tag = False diff --git a/README.md b/README.md index 517a8e89..8866930f 100644 --- a/README.md +++ b/README.md @@ -12,7 +12,7 @@ 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.0b1 of GraphQL-core is up-to-date +The current version 3.0.0 of GraphQL-core is up-to-date with GraphQL.js version 14.5.8. All parts of the API are covered by an extensive test suite @@ -46,12 +46,12 @@ README and the corresponding tests in parallel. GraphQL-core 3 can be installed from PyPI using the built-in pip command: - python -m pip install "graphql-core>=3a" + 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 --pre "graphql-core>=3a" + pipenv install "graphql-core>=3" ## Usage diff --git a/docs/conf.py b/docs/conf.py index 67a5ffa7..94876c08 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -61,7 +61,7 @@ # The short X.Y version. # version = u'3.0' # The full version, including alpha/beta/rc tags. -version = release = u'3.0.0b1' +version = release = u'3.0.0' # The language for content autogenerated by Sphinx. Refer to documentation # for a list of supported languages. @@ -96,6 +96,38 @@ } autosummary_generate = True +# ignore certain warnings +# (references to some of the Python built-in types do not resolve correctly) +nitpicky = True +nitpick_ignore = [('py:class', t) for t in ( + 'dict', 'list', 'object', 'tuple', + 'Exception', 'TypeError', 'ValueError', + 'builtins.str', 'enum.Enum', 'typing.Generic', + 'graphql.pyutils.cached_property.CachedProperty', + 'graphql.pyutils.path.Path', + 'graphql.error.graphql_error.GraphQLError', + 'graphql.language.ast.DefinitionNode', + 'graphql.language.ast.ExecutableDefinitionNode', + 'graphql.language.ast.Node', + 'graphql.language.ast.ScalarTypeDefinitionNode', + 'graphql.language.ast.SelectionNode', + 'graphql.language.ast.TypeDefinitionNode', + 'graphql.language.ast.TypeExtensionNode', + 'graphql.language.ast.TypeNode', + 'graphql.language.ast.TypeSystemDefinitionNode', + 'graphql.language.ast.ValueNode', + 'graphql.language.visitor.Visitor', + 'graphql.type.definition.GraphQLNamedType', + 'graphql.type.definition.GraphQLType', + 'graphql.type.definition.GraphQLWrappingType', + 'graphql.validation.rules.ASTValidationRule', + 'graphql.validation.rules.ValidationRule', + 'graphql.validation.validation_context.ASTValidationContext', + 'graphql.validation.rules.known_argument_names' + '.KnownArgumentNamesOnDirectivesRule', + 'graphql.validation.rules.provided_required_arguments' + '.ProvidedRequiredArgumentsOnDirectivesRule')] + # The reST default role (used for this markup: `text`) to use for all # documents. # diff --git a/docs/diffs.rst b/docs/diffs.rst index b660088e..7f45fd05 100644 --- a/docs/diffs.rst +++ b/docs/diffs.rst @@ -63,7 +63,7 @@ You can also pass a custom ``out_type`` argument to :class:`GraphQLInputObjectTy Custom Middleware ----------------- -The :func:`execution.execute` function takes an additional ``middleware`` argument which must be a sequence of middleware functions or a :class:`MiddleWareManager` object. This feature is used by Graphene to affect the evaluation of fields using custom middleware. +The :func:`execution.execute` function takes an additional ``middleware`` argument which must be a sequence of middleware functions or a :class:`MiddlewareManager` object. This feature is used by Graphene to affect the evaluation of fields using custom middleware. Custom execution contexts diff --git a/docs/intro.rst b/docs/intro.rst index ebe8d18c..0a8058fc 100644 --- a/docs/intro.rst +++ b/docs/intro.rst @@ -31,11 +31,11 @@ Getting started You can install GraphQL-core 3 using pip_:: - pip install "graphql-core>=3a" + pip install "graphql-core>=3" You can also install GraphQL-core 3 with pipenv_, if you prefer that:: - pipenv install --pre "graphql-core>=3a" + pipenv install "graphql-core>=3" Now you can start using GraphQL-core 3 by importing from the top-level :mod:`graphql` package. Nearly everything defined in the sub-packages @@ -83,8 +83,8 @@ 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-3: https://github.com/graphql-python/graphql-core-next +.. _GraphQL.js: https://github.com/graphql/graphql-js +.. _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 diff --git a/docs/requirements.txt b/docs/requirements.txt new file mode 100644 index 00000000..c5593704 --- /dev/null +++ b/docs/requirements.txt @@ -0,0 +1,2 @@ +sphinx>=2.2,<3 +sphinx_rtd_theme>=0.4 \ No newline at end of file diff --git a/pyproject.toml b/pyproject.toml index 67a0dd8b..f7516807 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -1,6 +1,6 @@ [tool.poetry] name = "graphql-core" -version = "3.0.0b1" +version = "3.0.0" description = """ GraphQL-core is a Python port of GraphQL.js, the JavaScript reference implementation for GraphQL.""" diff --git a/src/graphql/version.py b/src/graphql/version.py index 81183889..ad308762 100644 --- a/src/graphql/version.py +++ b/src/graphql/version.py @@ -4,7 +4,7 @@ __all__ = ["version", "version_info", "version_js", "version_info_js"] -version = "3.0.0b1" +version = "3.0.0" version_js = "14.5.8"