GraphQL implementation for Python
Project description
# GraphQL-core
GraphQL for Python.
_This library is a port of [graphql-js](https://github.com/graphql/graphql-js) to Python and currently is up-to-date with release [0.6.0](https://github.com/graphql/graphql-js/releases/tag/v0.6.0)._
[](https://badge.fury.io/py/graphql-core)
[](https://travis-ci.org/graphql-python/graphql-core)
[](https://coveralls.io/github/graphql-python/graphql-core?branch=master)
[](https://graphql-slack.herokuapp.com/)
See more complete documentation at http://graphql.org/ and
http://graphql.org/docs/api-reference-graphql/.
For questions, ask [Stack Overflow](http://stackoverflow.com/questions/tagged/graphql).
## Getting Started
An overview of the GraphQL language is available in the
[README](https://github.com/facebook/graphql/blob/master/README.md) for the
[Specification for GraphQL](https://github.com/facebook/graphql).
The overview describes a simple set of GraphQL examples that exist as [tests](https://github.com/graphql-python/graphql-core/tree/master/tests/)
in this repository. A good way to get started is to walk through that README and the corresponding tests
in parallel.
### Using graphql-core
Install from pip:
```sh
pip install graphql-core
```
GraphQL.js 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.
```python
from graphql import (
graphql,
GraphQLSchema,
GraphQLObjectType,
GraphQLField,
GraphQLString
)
schema = GraphQLSchema(
query= GraphQLObjectType(
name='RootQueryType',
fields={
'hello': GraphQLField(
type= GraphQLString,
resolver=lambda *_: 'world'
)
}
)
)
```
This defines a simple schema with one type and one field, that resolves
to a fixed value. The `resolve` function can return a value, a promise,
or an array of promises. A more complex example is included in the top
level [tests](https://github.com/graphql-python/graphql-core/tree/master/tests/) directory.
Then, serve the result of a query against that type schema.
```python
query = '{ hello }'
result = graphql(schema, query)
# Prints
# {'hello': 'world'} (as OrderedDict)
print result.data
```
This runs a query fetching the one field defined. The `graphql` function will
first ensure the query is syntactically and semantically valid before executing
it, reporting errors otherwise.
```python
query = '{ boyhowdy }'
result = graphql(schema, query)
# Prints
# [GraphQLError('Cannot query field "boyhowdy" on type "RootQueryType".',)]
print result.errors
```
### Executors
The graphql query is executed, by default, synchronously (using `SyncExecutor`).
However the following executors are available if we want to resolve our fields in parallel:
- `graphql.execution.executors.asyncio.AsyncioExecutor`: This executor executes the resolvers in the Python asyncio event loop.
- `graphql.execution.executors.gevent.GeventExecutor`: This executor executes the resolvers in the Gevent event loop.
- `graphql.execution.executors.process.ProcessExecutor`: This executor executes each resolver as a process.
- `graphql.execution.executors.thread.ThreadExecutor`: This executor executes each resolver in a Thread.
- `graphql.execution.executors.sync.SyncExecutor`: This executor executes each resolver synchronusly (default).
#### Usage
You can specify the executor to use via the executor keyword argument in the `grapqhl.execution.execute` function.
```python
from graphql.execution.execute import execute
execute(schema, ast, executor=SyncExecutor())
```
### Contributing
After cloning this repo, create a [virtualenv](https://virtualenv.pypa.io/en/stable/) and ensure dependencies are installed by running:
```sh
virtualenv venv
source venv/bin/activate
pip install -e ".[test]"
```
Well-written tests and maintaining good test coverage is important to this project. While developing, run new and existing tests with:
```sh
py.test PATH/TO/MY/DIR/test_test.py # Single file
py.test PATH/TO/MY/DIR/ # All tests in directory
```
Add the `-s` flag if you have introduced breakpoints into the code for debugging.
Add the `-v` ("verbose") flag to get more detailed test output. For even more detailed output, use `-vv`.
Check out the [pytest documentation](https://docs.pytest.org/en/latest/) for more options and test running controls.
GraphQL-core supports several versions of Python. To make sure that changes do not break compatibility with any of those versions, we use `tox` to create virtualenvs for each python version and run tests with that version. To run against all python versions defined in the `tox.ini` config file, just run:
```sh
tox
```
If you wish to run against a specific version defined in the `tox.ini` file:
```sh
tox -e py36
```
Tox can only use whatever versions of python are installed on your system. When you create a pull request, Travis will also be running the same tests and report the results, so there is no need for potential contributors to try to install every single version of python on their own system ahead of time. We appreciate opening issues and pull requests to make GraphQL-core even more stable & useful!
## Main Contributors
- [@syrusakbary](https://github.com/syrusakbary/)
- [@jhgg](https://github.com/jhgg/)
- [@dittos](https://github.com/dittos/)
## License
[MIT License](https://github.com/graphql-python/graphql-core/blob/master/LICENSE)
GraphQL for Python.
_This library is a port of [graphql-js](https://github.com/graphql/graphql-js) to Python and currently is up-to-date with release [0.6.0](https://github.com/graphql/graphql-js/releases/tag/v0.6.0)._
[](https://badge.fury.io/py/graphql-core)
[](https://travis-ci.org/graphql-python/graphql-core)
[](https://coveralls.io/github/graphql-python/graphql-core?branch=master)
[](https://graphql-slack.herokuapp.com/)
See more complete documentation at http://graphql.org/ and
http://graphql.org/docs/api-reference-graphql/.
For questions, ask [Stack Overflow](http://stackoverflow.com/questions/tagged/graphql).
## Getting Started
An overview of the GraphQL language is available in the
[README](https://github.com/facebook/graphql/blob/master/README.md) for the
[Specification for GraphQL](https://github.com/facebook/graphql).
The overview describes a simple set of GraphQL examples that exist as [tests](https://github.com/graphql-python/graphql-core/tree/master/tests/)
in this repository. A good way to get started is to walk through that README and the corresponding tests
in parallel.
### Using graphql-core
Install from pip:
```sh
pip install graphql-core
```
GraphQL.js 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.
```python
from graphql import (
graphql,
GraphQLSchema,
GraphQLObjectType,
GraphQLField,
GraphQLString
)
schema = GraphQLSchema(
query= GraphQLObjectType(
name='RootQueryType',
fields={
'hello': GraphQLField(
type= GraphQLString,
resolver=lambda *_: 'world'
)
}
)
)
```
This defines a simple schema with one type and one field, that resolves
to a fixed value. The `resolve` function can return a value, a promise,
or an array of promises. A more complex example is included in the top
level [tests](https://github.com/graphql-python/graphql-core/tree/master/tests/) directory.
Then, serve the result of a query against that type schema.
```python
query = '{ hello }'
result = graphql(schema, query)
# Prints
# {'hello': 'world'} (as OrderedDict)
print result.data
```
This runs a query fetching the one field defined. The `graphql` function will
first ensure the query is syntactically and semantically valid before executing
it, reporting errors otherwise.
```python
query = '{ boyhowdy }'
result = graphql(schema, query)
# Prints
# [GraphQLError('Cannot query field "boyhowdy" on type "RootQueryType".',)]
print result.errors
```
### Executors
The graphql query is executed, by default, synchronously (using `SyncExecutor`).
However the following executors are available if we want to resolve our fields in parallel:
- `graphql.execution.executors.asyncio.AsyncioExecutor`: This executor executes the resolvers in the Python asyncio event loop.
- `graphql.execution.executors.gevent.GeventExecutor`: This executor executes the resolvers in the Gevent event loop.
- `graphql.execution.executors.process.ProcessExecutor`: This executor executes each resolver as a process.
- `graphql.execution.executors.thread.ThreadExecutor`: This executor executes each resolver in a Thread.
- `graphql.execution.executors.sync.SyncExecutor`: This executor executes each resolver synchronusly (default).
#### Usage
You can specify the executor to use via the executor keyword argument in the `grapqhl.execution.execute` function.
```python
from graphql.execution.execute import execute
execute(schema, ast, executor=SyncExecutor())
```
### Contributing
After cloning this repo, create a [virtualenv](https://virtualenv.pypa.io/en/stable/) and ensure dependencies are installed by running:
```sh
virtualenv venv
source venv/bin/activate
pip install -e ".[test]"
```
Well-written tests and maintaining good test coverage is important to this project. While developing, run new and existing tests with:
```sh
py.test PATH/TO/MY/DIR/test_test.py # Single file
py.test PATH/TO/MY/DIR/ # All tests in directory
```
Add the `-s` flag if you have introduced breakpoints into the code for debugging.
Add the `-v` ("verbose") flag to get more detailed test output. For even more detailed output, use `-vv`.
Check out the [pytest documentation](https://docs.pytest.org/en/latest/) for more options and test running controls.
GraphQL-core supports several versions of Python. To make sure that changes do not break compatibility with any of those versions, we use `tox` to create virtualenvs for each python version and run tests with that version. To run against all python versions defined in the `tox.ini` config file, just run:
```sh
tox
```
If you wish to run against a specific version defined in the `tox.ini` file:
```sh
tox -e py36
```
Tox can only use whatever versions of python are installed on your system. When you create a pull request, Travis will also be running the same tests and report the results, so there is no need for potential contributors to try to install every single version of python on their own system ahead of time. We appreciate opening issues and pull requests to make GraphQL-core even more stable & useful!
## Main Contributors
- [@syrusakbary](https://github.com/syrusakbary/)
- [@jhgg](https://github.com/jhgg/)
- [@dittos](https://github.com/dittos/)
## License
[MIT License](https://github.com/graphql-python/graphql-core/blob/master/LICENSE)
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
graphql-core-2.1.tar.gz
(96.3 kB
view hashes)
Built Distribution
graphql_core-2.1-py2.py3-none-any.whl
(249.4 kB
view hashes)
Close
Hashes for graphql_core-2.1-py2.py3-none-any.whl
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 9462e22e32c7f03b667373ec0a84d95fba10e8ce2ead08f29fbddc63b671b0c1 |
|
| MD5 | 8fe333dc0e43b7149b7ec51dc0fdcc36 |
|
| BLAKE2b-256 | 35dd2dff553c929d059e53a95a8bcff66f6a3930d736dfea17f88d16229eaf84 |
