GraphQL Framework for Python
Project description
Graphene 
���� Join the community on Discord
We are looking for contributors! Please check the current issues to see how you can help ������
Introduction
Graphene is an opinionated Python library for building GraphQL schemas/types fast and easily.
- Easy to use: Graphene helps you use GraphQL in Python without effort.
- Relay: Graphene has builtin support for Relay.
- Data agnostic: Graphene supports any kind of data source: SQL (Django, SQLAlchemy), Mongo, custom Python objects, etc. We believe that by providing a complete API you could plug Graphene anywhere your data lives and make your data available through GraphQL.
Integrations
Graphene has multiple integrations with different frameworks:
| integration | Package |
|---|---|
| SQLAlchemy | graphene-sqlalchemy |
| Mongo | graphene-mongo |
| Apollo Federation | graphene-federation |
| Django | graphene-django |
Also, Graphene is fully compatible with the GraphQL spec, working seamlessly with all GraphQL clients, such as Relay, Apollo and gql.
Installation
To install graphene, just run this command in your shell
pip install "graphene>=3.1"
Examples
Here is one example for you to get started:
import graphene
class Query(graphene.ObjectType):
hello = graphene.String(description='A typical hello world')
def resolve_hello(self, info):
return 'World'
schema = graphene.Schema(query=Query)
Then Querying graphene.Schema is as simple as:
query = '''
query SayHello {
hello
}
'''
result = schema.execute(query)
If you want to learn even more, you can also check the following examples:
- Basic Schema: Starwars example
- Relay Schema: Starwars Relay example
Documentation
Documentation and links to additional resources are available at https://docs.graphene-python.org/en/latest/
Contributing
After cloning this repo, create a virtualenv and ensure dependencies are installed by running:
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:
pytest graphene/relay/tests/test_node.py # Single file
pytest graphene/relay # 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 for more options and test running controls.
Regularly ensure your pre-commit hooks are up to date and enabled:
pre-commit install
You can also run the benchmarks with:
pytest graphene --benchmark-only
Graphene 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:
tox
If you wish to run against a specific version defined in the tox.ini file:
tox -e py39
Tox can only use whatever versions of Python are installed on your system. When you create a pull request, GitHub Actions pipelines 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 graphene even more stable & useful!
Building Documentation
The documentation is generated using the excellent Sphinx and a custom theme.
An HTML version of the documentation is produced by running:
make docs
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
Built Distribution
File details
Details for the file graphene-3.4.1.tar.gz.
File metadata
- Download URL: graphene-3.4.1.tar.gz
- Upload date:
- Size: 44.7 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/4.0.2 CPython/3.7.17
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 828a8d7b1bce450566a72cc8733716c20f3acfc659960de73dd38f46dc302040 |
|
| MD5 | 75dbac546dd5200c43b91ddc5b8894f8 |
|
| BLAKE2b-256 | 7e55a39c9de3d3333831e03e7546fe6cd1c86c870fe6cd043f3eb0186000e456 |
Provenance
File details
Details for the file graphene-3.4.1-py2.py3-none-any.whl.
File metadata
- Download URL: graphene-3.4.1-py2.py3-none-any.whl
- Upload date:
- Size: 114.7 kB
- Tags: Python 2, Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/4.0.2 CPython/3.7.17
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | ca98f853201293871cdc7f55faf2523a9bc077181fe0f4947db5a243e5c67083 |
|
| MD5 | 7cd3c65283cd24a9a52ba5bb6aa2adf5 |
|
| BLAKE2b-256 | 7a53cdde1b7ae046c3763f3927bfceacfc6b7f34ea631dc39adfba83b2809c86 |
