graphql-server


Namegraphql-server JSON
Version 3.0.0b7 PyPI version JSON
download
home_pagehttps://github.com/graphql-python/graphql-server
SummaryGraphQL Server tools for powering your server
upload_time2023-10-16 09:16:17
maintainer
docs_urlNone
authorSyrus Akbary
requires_python
licenseMIT
keywords api graphql protocol rest
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls.
            <img src="https://raw.githubusercontent.com/graphql-python/graphql-server/master/docs/_static/graphql-server-logo.svg" height="128px">

[![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)

            

Raw data

            {
    "_id": null,
    "home_page": "https://github.com/graphql-python/graphql-server",
    "name": "graphql-server",
    "maintainer": "",
    "docs_url": null,
    "requires_python": "",
    "maintainer_email": "",
    "keywords": "api graphql protocol rest",
    "author": "Syrus Akbary",
    "author_email": "me@syrusakbary.com",
    "download_url": "https://files.pythonhosted.org/packages/be/9b/f77057d5994fde058eb437413fc94db0831e34939321493ecfbbd3ffbfdc/graphql-server-3.0.0b7.tar.gz",
    "platform": "any",
    "description": "<img src=\"https://raw.githubusercontent.com/graphql-python/graphql-server/master/docs/_static/graphql-server-logo.svg\" height=\"128px\">\n\n[![PyPI version](https://badge.fury.io/py/graphql-server.svg)](https://badge.fury.io/py/graphql-server)\n[![Coverage Status](https://codecov.io/gh/graphql-python/graphql-server/branch/master/graph/badge.svg)](https://codecov.io/gh/graphql-python/graphql-server)\n\nGraphQL-Server is a base library that serves as a helper\nfor building GraphQL servers or integrations into existing web frameworks using\n[GraphQL-Core](https://github.com/graphql-python/graphql-core).\n\n## Integrations built with GraphQL-Server\n\n| Server integration          | Docs                                                                                    |\n| --------------------------- | --------------------------------------------------------------------------------------- |\n| Flask                       | [flask](https://github.com/graphql-python/graphql-server/blob/master/docs/flask.md)     |\n| Sanic                       | [sanic](https://github.com/graphql-python/graphql-server/blob/master/docs/sanic.md)     |\n| AIOHTTP                     | [aiohttp](https://github.com/graphql-python/graphql-server/blob/master/docs/aiohttp.md) |\n| WebOb (Pyramid, TurboGears) | [webob](https://github.com/graphql-python/graphql-server/blob/master/docs/webob.md)     |\n\n## Other integrations built with GraphQL-Server\n\n| Server integration | Package                                                                                                 |\n| ------------------ | ------------------------------------------------------------------------------------------------------- |\n| WSGI               | [wsgi-graphql](https://github.com/moritzmhmk/wsgi-graphql)                                              |\n| Responder          | [responder.ext.graphql](https://github.com/kennethreitz/responder/blob/master/responder/ext/graphql.py) |\n\n## Other integrations using GraphQL-Core or Graphene\n\n| Server integration | Package                                                               |\n| ------------------ | --------------------------------------------------------------------- |\n| Django             | [graphene-django](https://github.com/graphql-python/graphene-django/) |\n\n## Documentation\n\nThe `graphql_server` package provides these public helper functions:\n\n- `run_http_query`\n- `encode_execution_results`\n- `load_json_body`\n- `json_encode`\n- `json_encode_pretty`\n\n**NOTE:** the `json_encode_pretty` is kept as backward compatibility change as it uses `json_encode` with `pretty` parameter set to `True`.\n\nAll functions in the package are annotated with type hints and docstrings,\nand you can build HTML documentation from these using `bin/build_docs`.\n\nYou can also use one of the existing integrations listed above as\nblueprint to build your own integration or GraphQL server implementations.\n\nPlease let us know when you have built something new, so we can list it here.\n\n## Contributing\n\nSee [CONTRIBUTING.md](https://github.com/graphql-python/graphql-server/blob/master/CONTRIBUTING.md)\n",
    "bugtrack_url": null,
    "license": "MIT",
    "summary": "GraphQL Server tools for powering your server",
    "version": "3.0.0b7",
    "project_urls": {
        "Download": "https://github.com/graphql-python/graphql-server/releases",
        "Homepage": "https://github.com/graphql-python/graphql-server"
    },
    "split_keywords": [
        "api",
        "graphql",
        "protocol",
        "rest"
    ],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "be9bf77057d5994fde058eb437413fc94db0831e34939321493ecfbbd3ffbfdc",
                "md5": "8b9dc3b4573a22d807e23694f3b5403f",
                "sha256": "99adc23fb40c2e5d304215e2730b945f2883ee008c93f302438d849ab1d4e9e7"
            },
            "downloads": -1,
            "filename": "graphql-server-3.0.0b7.tar.gz",
            "has_sig": false,
            "md5_digest": "8b9dc3b4573a22d807e23694f3b5403f",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": null,
            "size": 48834,
            "upload_time": "2023-10-16T09:16:17",
            "upload_time_iso_8601": "2023-10-16T09:16:17.276375Z",
            "url": "https://files.pythonhosted.org/packages/be/9b/f77057d5994fde058eb437413fc94db0831e34939321493ecfbbd3ffbfdc/graphql-server-3.0.0b7.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2023-10-16 09:16:17",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "graphql-python",
    "github_project": "graphql-server",
    "travis_ci": false,
    "coveralls": false,
    "github_actions": true,
    "tox": true,
    "lcname": "graphql-server"
}
        
Elapsed time: 4.03758s