Ravenports generated: 10 Sep 2023 21:15
[ravenports.git] / bucket_96 / python-graphql-core
1 # Buildsheet autogenerated by ravenadm tool -- Do not edit.
2
3 NAMEBASE=               python-graphql-core
4 VERSION=                3.2.3
5 KEYWORDS=               python
6 VARIANTS=               py310 v11
7 SDESC[py310]=           GraphQL implementation (3.10)
8 SDESC[v11]=             GraphQL implementation (3.11)
9 HOMEPAGE=               https://github.com/graphql-python/graphql-core
10 CONTACT=                Python_Automaton[python@ironwolf.systems]
11
12 DOWNLOAD_GROUPS=        main
13 SITES[main]=            PYPIWHL/f8/39/e5143e7ec70939d2076c1165ae9d4a3815597019c4d797b7f959cf778600
14 DISTFILE[1]=            graphql_core-3.2.3-py3-none-any.whl:main
15 DF_INDEX=               1
16 SPKGS[py310]=           single
17 SPKGS[v11]=             single
18
19 OPTIONS_AVAILABLE=      PY310 PY311
20 OPTIONS_STANDARD=       none
21 VOPTS[py310]=           PY310=ON PY311=OFF
22 VOPTS[v11]=             PY310=OFF PY311=ON
23
24 DISTNAME=               graphql_core-3.2.3.dist-info
25
26 GENERATED=              yes
27
28 [PY310].USES_ON=                        python:py310,wheel
29
30 [PY311].USES_ON=                        python:v11,wheel
31
32 [FILE:3072:descriptions/desc.single]
33 # GraphQL-core 3
34
35 GraphQL-core 3 is a Python 3.6+ port of [GraphQL.js],
36 the JavaScript reference implementation for [GraphQL],
37 a query language for APIs created by Facebook.
38
39 [PyPI version]
40 [Documentation Status]
41 ![Test Status]
42 ![Lint Status]
43 [Code Style]
44
45 The current version 3.2.3 of GraphQL-core is up-to-date with GraphQL.js
46 version 16.6.0.
47
48 An extensive test suite with over 2300 unit tests and 100% coverage
49 comprises a
50 replication of the complete test suite of GraphQL.js, making sure this port
51 is
52 reliable and compatible with GraphQL.js.
53
54 Note that for various reasons, GraphQL-core does not use SemVer like
55 GraphQL.js. Increases in the major version of GraphQL.js are reflected in
56 the minor version of GraphQL-core instead. This means there can be breaking
57 changes in the API when the minor version changes, and only patch releases
58 are fully backward compatible. Therefore, we recommend something like `=~
59 3.2.0` as version specifier when including GraphQL-core as a dependency.
60
61 ## Documentation
62
63 A more detailed documentation for GraphQL-core 3 can be found at
64 [graphql-core-3.readthedocs.io].
65
66 The documentation for GraphQL.js can be found at [graphql.org/graphql-js/].
67
68 The documentation for GraphQL itself can be found at [graphql.org].
69
70 There will be also [blog articles] with more usage
71 examples.
72
73 ## Getting started
74
75 A general overview of GraphQL is available in the
76 [README] for the
77 [Specification for GraphQL]. That overview
78 describes a simple set of GraphQL examples that exist as [tests] in this
79 repository. A good way to get started with this repository is to walk
80 through that
81 README and the corresponding tests in parallel.
82
83 ## Installation
84
85 GraphQL-core 3 can be installed from PyPI using the built-in pip command:
86
87     python -m pip install graphql-core
88
89 You can also use [poetry] for installation in a
90 virtual environment:
91
92     poetry install
93
94 ## Usage
95
96 GraphQL-core provides two important capabilities: building a type schema
97 and
98 serving queries against that type schema.
99
100 First, build a GraphQL type schema which maps to your codebase:
101
102 ```python
103 from graphql import (
104     GraphQLSchema, GraphQLObjectType, GraphQLField, GraphQLString)
105
106 schema = GraphQLSchema(
107     query=GraphQLObjectType(
108         name='RootQueryType',
109         fields={
110             'hello': GraphQLField(
111                 GraphQLString,
112                 resolve=lambda obj, info: 'world')
113         }))
114 ```
115
116 This defines a simple schema, with one type and one field, that resolves to
117 a fixed
118 value. The `resolve` function can return a value, a co-routine object or a
119 list of
120 these. It takes two positional arguments; the first one provides the root
121 or the
122 resolved parent field, the second one provides a `GraphQLResolveInfo`
123 object which
124 contains information about the execution state of the query, including a
125 `context`
126 attribute holding per-request state such as authentication information or
127 database
128 session. Any GraphQL arguments are passed to the `resolve` functions as
129 individual
130 keyword arguments.
131
132 Note that the signature of the resolver functions is a bit different in
133
134
135 [FILE:114:distinfo]
136 5766780452bd5ec8ba133f8bf287dc92713e3868ddd83aee4faab9fc3e303dc3       202921 graphql_core-3.2.3-py3-none-any.whl
137