https://github.com/graphql-python/graphql-server

This is the core package for using GraphQL in a custom server easily
https://github.com/graphql-python/graphql-server

aiohttp api flask graphql graphql-python graphql-servers quart sanic webob

Last synced: 5 days ago
JSON representation

This is the core package for using GraphQL in a custom server easily

• Host: GitHub
• URL: https://github.com/graphql-python/graphql-server
• Owner: graphql-python
• License: mit
• Created: 2017-03-23T03:32:26.000Z (almost 8 years ago)
• Default Branch: master
• Last Pushed: 2024-02-26T06:55:08.000Z (10 months ago)
• Last Synced: 2024-12-11T12:02:13.276Z (12 days ago)
• Topics: aiohttp, api, flask, graphql, graphql-python, graphql-servers, quart, sanic, webob
• Language: Python
• Homepage:
• Size: 290 KB
• Stars: 122
• Watchers: 12
• Forks: 72
• Open Issues: 17
• Metadata Files:
  • Readme: README.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE

Awesome Lists containing this project

README

        


[![PyPI version](https://badge.fury.io/py/graphql-server.svg)](https://badge.fury.io/py/graphql-server)

[![Coverage Status](https://codecov.io/gh/graphql-python/graphql-server/branch/master/graph/badge.svg)](https://codecov.io/gh/graphql-python/graphql-server)

GraphQL-Server is a base library that serves as a helper

for building GraphQL servers or integrations into existing web frameworks using

[GraphQL-Core](https://github.com/graphql-python/graphql-core).

## Integrations built with GraphQL-Server

| Server integration          | Docs                                                                                    |

| --------------------------- | --------------------------------------------------------------------------------------- |

| Flask                       | [flask](https://github.com/graphql-python/graphql-server/blob/master/docs/flask.md)     |

| Sanic                       | [sanic](https://github.com/graphql-python/graphql-server/blob/master/docs/sanic.md)     |

| AIOHTTP                     | [aiohttp](https://github.com/graphql-python/graphql-server/blob/master/docs/aiohttp.md) |

| WebOb (Pyramid, TurboGears) | [webob](https://github.com/graphql-python/graphql-server/blob/master/docs/webob.md)     |

## Other integrations built with GraphQL-Server

| Server integration | Package                                                                                                 |

| ------------------ | ------------------------------------------------------------------------------------------------------- |

| WSGI               | [wsgi-graphql](https://github.com/moritzmhmk/wsgi-graphql)                                              |

| Responder          | [responder.ext.graphql](https://github.com/kennethreitz/responder/blob/master/responder/ext/graphql.py) |

## Other integrations using GraphQL-Core or Graphene

| Server integration | Package                                                               |

| ------------------ | --------------------------------------------------------------------- |

| Django             | [graphene-django](https://github.com/graphql-python/graphene-django/) |

## Documentation

The `graphql_server` package provides these public helper functions:

- `run_http_query`

- `encode_execution_results`

- `load_json_body`

- `json_encode`

- `json_encode_pretty`

**NOTE:** the `json_encode_pretty` is kept as backward compatibility change as it uses `json_encode` with `pretty` parameter set to `True`.

All functions in the package are annotated with type hints and docstrings,

and you can build HTML documentation from these using `bin/build_docs`.

You can also use one of the existing integrations listed above as

blueprint to build your own integration or GraphQL server implementations.

Please let us know when you have built something new, so we can list it here.

## Contributing

See [CONTRIBUTING.md](https://github.com/graphql-python/graphql-server/blob/master/CONTRIBUTING.md)