graphene/README.rst

138 lines
4.7 KiB
ReStructuredText
Raw Normal View History

Please read `UPGRADE-v1.0.md </UPGRADE-v1.0.md>`__ to learn how to
upgrade to Graphene ``1.0``.
2016-09-09 07:30:30 +03:00
--------------
|Graphene Logo| `Graphene <http://graphene-python.org>`__ |Build Status| |PyPI version| |Coverage Status|
=========================================================================================================
2015-10-07 07:04:24 +03:00
`Graphene <http://graphene-python.org>`__ is a Python library for
building GraphQL schemas/types fast and easily.
2015-10-30 23:40:36 +03:00
- **Easy to use:** Graphene helps you use GraphQL in Python without
effort.
2017-02-18 23:50:58 +03:00
- **Relay:** Graphene has builtin support for both Relay.
- **Data agnostic:** Graphene supports any kind of data source: SQL
(Django, SQLAlchemy), NoSQL, 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.
2015-10-07 07:04:24 +03:00
Integrations
------------
Graphene has multiple integrations with different frameworks:
2015-10-30 10:01:44 +03:00
+---------------------+----------------------------------------------------------------------------------------------+
| integration | Package |
+=====================+==============================================================================================+
| Django | `graphene-django <https://github.com/graphql-python/graphene-django/>`__ |
+---------------------+----------------------------------------------------------------------------------------------+
| SQLAlchemy | `graphene-sqlalchemy <https://github.com/graphql-python/graphene-sqlalchemy/>`__ |
+---------------------+----------------------------------------------------------------------------------------------+
| Google App Engine | `graphene-gae <https://github.com/graphql-python/graphene-gae/>`__ |
+---------------------+----------------------------------------------------------------------------------------------+
| Peewee | *In progress* (`Tracking Issue <https://github.com/graphql-python/graphene/issues/289>`__) |
+---------------------+----------------------------------------------------------------------------------------------+
2015-11-30 11:25:18 +03:00
2017-02-18 23:50:58 +03:00
Also, Graphene is fully compatible with the GraphQL spec, working
seamlessly with all GraphQL clients, such as
`Relay <https://github.com/facebook/relay>`__,
`Apollo <https://github.com/apollographql/apollo-client>`__ and
`gql <https://github.com/graphql-python/gql>`__.
2015-10-07 07:04:24 +03:00
Installation
------------
For instaling graphene, just run this command in your shell
.. code:: bash
2016-09-26 19:16:27 +03:00
pip install "graphene>=1.0"
2015-10-07 07:04:24 +03:00
2016-09-09 07:30:30 +03:00
1.0 Upgrade Guide
-----------------
Please read `UPGRADE-v1.0.md </UPGRADE-v1.0.md>`__ to learn how to
upgrade.
2016-09-09 07:30:30 +03:00
Examples
--------
2015-10-07 07:04:24 +03:00
2017-01-22 11:46:31 +03:00
Here is one example for you to get started:
2015-10-07 07:04:24 +03:00
.. code:: python
class Query(graphene.ObjectType):
hello = graphene.String(description='A typical hello world')
2015-10-07 07:04:24 +03:00
def resolve_hello(self, args, context, info):
return 'World'
2015-10-07 07:04:24 +03:00
schema = graphene.Schema(query=Query)
Then Querying ``graphene.Schema`` is as simple as:
2015-10-07 07:04:24 +03:00
.. code:: python
query = '''
query SayHello {
hello
2015-10-07 07:04:24 +03:00
}
'''
result = schema.execute(query)
If you want to learn even more, you can also check the following
`examples <examples/>`__:
2015-10-07 07:04:24 +03:00
- **Basic Schema**: `Starwars example <examples/starwars>`__
- **Relay Schema**: `Starwars Relay
example <examples/starwars_relay>`__
2015-10-07 07:04:24 +03:00
Contributing
------------
After cloning this repo, ensure dependencies are installed by running:
.. code:: sh
2017-02-08 08:54:50 +03:00
pip install .[test]
2015-10-07 07:04:24 +03:00
After developing, the full test suite can be evaluated by running:
.. code:: sh
2017-02-08 08:54:50 +03:00
py.test graphene --cov=graphene --benchmark-skip # Use -v -s for verbose mode
You can also run the benchmarks with:
.. code:: sh
py.test graphene --benchmark-only
2015-10-07 07:04:24 +03:00
Documentation
~~~~~~~~~~~~~
The documentation is generated using the excellent
`Sphinx <http://www.sphinx-doc.org/>`__ and a custom theme.
The documentation dependencies are installed by running:
.. code:: sh
cd docs
pip install -r requirements.txt
Then to produce a HTML version of the documentation:
.. code:: sh
make html
.. |Graphene Logo| image:: http://graphene-python.org/favicon.png
2015-10-07 07:04:24 +03:00
.. |Build Status| image:: https://travis-ci.org/graphql-python/graphene.svg?branch=master
:target: https://travis-ci.org/graphql-python/graphene
.. |PyPI version| image:: https://badge.fury.io/py/graphene.svg
:target: https://badge.fury.io/py/graphene
2015-10-07 07:04:24 +03:00
.. |Coverage Status| image:: https://coveralls.io/repos/graphql-python/graphene/badge.svg?branch=master&service=github
:target: https://coveralls.io/github/graphql-python/graphene?branch=master