Metadata-Version: 2.1
Name: ariadne
Version: 0.2.0b1
Summary: Ariadne is a Python library for implementing GraphQL servers.
Home-page: https://github.com/mirumee/ariadne
Author: Mirumee Software
Author-email: hello@mirumee.com
License: BSD
Description: ![Ariadne](https://ariadne.readthedocs.io/en/master/_images/logo.png)
        
        [![Documentation](https://readthedocs.org/projects/ariadne/badge/?version=master)](https://ariadne.readthedocs.io/)
        [![Build Status](https://travis-ci.org/mirumee/ariadne.svg?branch=master)](https://travis-ci.org/mirumee/ariadne)
        [![Codecov](https://codecov.io/gh/mirumee/ariadne/branch/master/graph/badge.svg)](https://codecov.io/gh/mirumee/ariadne)
        
        - - - - -
        
        # Ariadne
        
        Ariadne is a Python library for implementing [GraphQL](http://graphql.github.io/) servers, inspired by [Apollo Server](https://www.apollographql.com/docs/apollo-server/) and built with [GraphQL-core-next](https://github.com/graphql-python/graphql-core-next).
        
        The library already implements enough features to enable developers to build functional GraphQL APIs. It is also being dogfooded internally on a number of projects.
        
        Documentation is available [here](https://ariadne.readthedocs.io/).
        
        
        ## Installation
        
        Ariadne can be installed with pip:
        
            pip install ariadne
        
        
        ## Quickstart 
        
        The following example creates an API defining `Person` type and single query field `people` returning a list of two persons. It also starts a local dev server with [GraphQL Playground](https://github.com/prisma/graphql-playground) available on the `http://127.0.0.1:8888` address.
        
        ```python
        from ariadne import ResolverMap, gql, start_simple_server
        
        # Define types using Schema Definition Language (https://graphql.org/learn/schema/)
        # Wrapping string in gql function provides validation and better error traceback
        type_defs = gql("""
            type Query {
                people: [Person!]!
            }
        
            type Person {
                firstName: String
                lastName: String
                age: Int
                fullName: String
            }
        """)
        
        # Map resolver functions to type fields using ResolverMap
        query = ResolverMap("Query")
        
        # Resolvers are simple python functions
        @query.field("people")
        def resolve_people(*_):
            return [
                {"firstName": "John", "lastName": "Doe", "age": 21},
                {"firstName": "Bob", "lastName": "Boberson", "age": 24},
            ]
        
        
        person = ResolverMap("Person")
        
        @person.field("fullname")
        def resolve_person_fullname(person, *_):
            return "%s %s" % (person["firstName"], person["lastName"])
        
        # Create and run dev server that provides api browser
        start_simple_server(type_defs, [query, person]) # Visit http://127.0.0.1:8888 to see API browser!
        ```
        
        For more guides and examples, please see the [documentation](https://ariadne.readthedocs.io/).
        
        
        Contributing
        ------------
        
        We are welcoming contributions to Ariadne! If you've found a bug or issue, or if you have any questions or feedback, feel free to use [GitHub issues](https://github.com/mirumee/ariadne/issues).
        
        For guidance and instructions, please see [CONTRIBUTING.md](CONTRIBUTING.md).
        
Platform: any
Classifier: Development Status :: 4 - Beta
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: BSD License
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: 3.7
Classifier: Topic :: Software Development :: Libraries :: Python Modules
Description-Content-Type: text/markdown
