tartiflette 1.4.1

GraphQL Engine for Python

Tartiflette is a GraphQL Server implementation built with Python 3.6+.

Summary

• Motivation
• Status
• Usage
• Installation
  • Building from source
• HTTP server implementations
• Roadmaps
• How to contribute to the documentation?
  • How to run the website locally?

Motivation

Read this blogpost about our motivations TL; DR We reached the limits of Graphene, we wanted to build something which met certain requirements:

• Offers a better developer experience that respects the Python mindset
• Uses SDL (Schema Definition Language)
• Uses asyncio as the sole execution engine
• Be 100% open source

Status

The first milestone is behind us, we are now on the road to the milestone 2.

DNA

• Define the GraphQL schema with the brand new SDL (Schema Definition Language).
• Performance oriented: Performance is the core of our work.
• Simple is better than complex: Built with the Zen of Python in mind. No over-engineering.

Discover Tartiflette with our fabulous tutorial on https://tartiflette.io/docs/tutorial/getting-started

Usage

import asyncio

from tartiflette import Resolver, create_engine

@Resolver("Query.hello")
async def resolver_hello(parent, args, ctx, info):
    return "hello " + args["name"]


async def run():
    engine = await create_engine(
        """
        type Query {
            hello(name: String): String
        }
        """
    )

    result = await engine.execute(
        query='query { hello(name: "Chuck") }'
    )

    print(result)
    # {'data': {'hello': 'hello Chuck'}}

if __name__ == "__main__":
    loop = asyncio.get_event_loop()
    loop.run_until_complete(run())

More details on the API Documentation

Installation

Tartiflette is available on pypi.org.

While the project depends on libgraphqlparser, wheels are provided since version 1.4.0, ensuring that no system dependency is required.

To install the library:

pip install tartiflette

Building from source

If you use a platform incompatible with the provided wheels, you'll need to install cmake to build libgraphqlparser in order to install the library.

macOS

brew install cmake

Debian/Ubuntu

apt-get install cmake

HTTP server implementations

tartiflette library itself is transport agnostic, but to simplify integration with existing HTTP servers, two different libraries are available:

• tartiflette-aiohttp: integration with aiohttp
• tartiflette-asgi: integration with ASGI compatible HTTP servers

Roadmaps

• Milestone 1 (Released)
• Milestone 2 - Work in progress

How to contribute to the documentation?

As you may know, the documentation is hosted on https://tartiflette.io. This fabulous website is built thanks to another amazing tool, docusaurus.

The content of the documentation is hosted in this repository, to be as close as possible to the code. You will find everything you need/want in the folder /docs.

How to run the website locally?

We built a docker image for the documentation (tartiflette/tartiflette.io on docker hub), which allow us to provide you an easy way to launch the documentation locally, without installing a specific version of node.

prerequisite:

• Docker
• Docker Compose
• Make

make run-docs

Every change you will make in the /docs folder will be automatically hot reloaded. :tada: