Repository files navigation

💬 Join the community on Discord

We are looking for contributors! Please check the current issues to see how you can help ❤️

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 availablethrough GraphQL.

Graphene has multiple integrations with different frameworks:

Also, Graphene is fully compatible with the GraphQL spec, working seamlessly with all GraphQL clients, such asRelay,Apollo andgql.

To installgraphene, just run this command in your shell

pip install"graphene>=3.1"

Here is one example for you to get started:

importgrapheneclassQuery(graphene.ObjectType):hello=graphene.String(description='A typical hello world')defresolve_hello(self,info):return'World'schema=graphene.Schema(query=Query)

Then Queryinggraphene.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 followingexamples:

• Basic Schema:Starwars example
• Relay Schema:Starwars Relay example

Documentation and links to additional resources are available athttps://docs.graphene-python.org/en/latest/

After cloning this repo, create avirtualenv and ensure dependencies are installed by running:

virtualenv venvsource venv/bin/activatepip 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 filepytest 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 thepytest documentation for more options and test running controls.

Regularly ensure yourpre-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 usetox to create virtualenvs for each Python version and run tests with that version. To run against all Python versions defined in thetox.ini config file, just run:

tox

If you wish to run against a specific version defined in thetox.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!

The documentation is generated using the excellentSphinx and a custom theme.

An HTML version of the documentation is produced by running:

make docs