graphql-python/graphene
1
1
Fork 0
mirror of https://github.com/graphql-python/graphene.git synced 2024-11-22 09:36:44 +03:00
Code Issues Packages Projects Releases Wiki Activity

update README.rst using pandoc

Browse Source
This commit is contained in:
Mel van Londen 2021-11-13 14:25:10 -08:00
parent 27f19e5a90
commit a61f0a214d
1 changed files with 43 additions and 48 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

91
README.rst
View File

@ -1,18 +1,18 @@
|Graphene Logo| `Graphene <http://graphene-python.org>`__ |Build Status| |PyPI version| |Coverage Status|
=========================================================================================================
`💬 Join the community on
Slack <https://join.slack.com/t/graphenetools/shared_invite/enQtOTE2MDQ1NTg4MDM1LTA4Nzk0MGU0NGEwNzUxZGNjNDQ4ZjAwNDJjMjY0OGE1ZDgxZTg4YjM2ZTc4MjE2ZTAzZjE2ZThhZTQzZTkyMmM>`__
**We are looking for contributors**! Please check the **We are looking for contributors**! Please check the
`ROADMAP <https://github.com/graphql-python/graphene/blob/master/ROADMAP.md>`__ `ROADMAP <https://github.com/graphql-python/graphene/blob/master/ROADMAP.md>`__
to see how you can help ❤️ to see how you can help ❤️
--------------
|Graphene Logo| `Graphene <http://graphene-python.org>`__ |Build Status| |PyPI version| |Coverage Status|
=========================================================================================================
Introduction Introduction
------------ ------------
`Graphene <http://graphene-python.org>`__ is a Python library for `Graphene <http://graphene-python.org>`__ is an opinionated Python
building GraphQL schemas/types fast and easily. library for building GraphQL schemas/types fast and easily.
- **Easy to use:** Graphene helps you use GraphQL in Python without - **Easy to use:** Graphene helps you use GraphQL in Python without
effort. effort.
@ -27,17 +27,18 @@ Integrations
Graphene has multiple integrations with different frameworks: Graphene has multiple integrations with different frameworks:
+---------------------+----------------------------------------------------------------------------------------------+ +-------------------+-------------------------------------------------+
| integration | Package | | integration | Package |
+=====================+==============================================================================================+ +===================+=================================================+
| Django | `graphene-django <https://github.com/graphql-python/graphene-django/>`__ | | Django | `graphene-django <https:/ |
+---------------------+----------------------------------------------------------------------------------------------+ | | /github.com/graphql-python/graphene-django/>`__ |
| SQLAlchemy | `graphene-sqlalchemy <https://github.com/graphql-python/graphene-sqlalchemy/>`__ | +-------------------+-------------------------------------------------+
+---------------------+----------------------------------------------------------------------------------------------+ | SQLAlchemy | `graphene-sqlalchemy <https://git |
| Google App Engine | `graphene-gae <https://github.com/graphql-python/graphene-gae/>`__ | | | hub.com/graphql-python/graphene-sqlalchemy/>`__ |
+---------------------+----------------------------------------------------------------------------------------------+ +-------------------+-------------------------------------------------+
| Peewee | *In progress* (`Tracking Issue <https://github.com/graphql-python/graphene/issues/289>`__) | | Google App Engine | `graphene-gae <http |
+---------------------+----------------------------------------------------------------------------------------------+ | | s://github.com/graphql-python/graphene-gae/>`__ |
+-------------------+-------------------------------------------------+
Also, Graphene is fully compatible with the GraphQL spec, working Also, Graphene is fully compatible with the GraphQL spec, working
seamlessly with all GraphQL clients, such as seamlessly with all GraphQL clients, such as
@ -52,13 +53,7 @@ For instaling graphene, just run this command in your shell
.. code:: bash .. code:: bash
pip install "graphene>=2.0" pip install "graphene>=3.0"
2.0 Upgrade Guide
-----------------
Please read `UPGRADE-v2.0.md </UPGRADE-v2.0.md>`__ to learn how to
upgrade.
Examples Examples
-------- --------
@ -67,26 +62,26 @@ Here is one example for you to get started:
.. code:: python .. code:: python
import graphene import graphene
class Query(graphene.ObjectType): class Query(graphene.ObjectType):
hello = graphene.String(description='A typical hello world') hello = graphene.String(description='A typical hello world')
def resolve_hello(self, info): def resolve_hello(self, info):
return 'World' return 'World'
schema = graphene.Schema(query=Query) schema = graphene.Schema(query=Query)
Then Querying ``graphene.Schema`` is as simple as: Then Querying ``graphene.Schema`` is as simple as:
.. code:: python .. code:: python
query = ''' query = '''
query SayHello { query SayHello {
hello hello
} }
''' '''
result = schema.execute(query) result = schema.execute(query)
If you want to learn even more, you can also check the following If you want to learn even more, you can also check the following
`examples <examples/>`__: `examples <examples/>`__:
@ -110,20 +105,20 @@ dependencies are installed by running:
.. code:: sh .. code:: sh
virtualenv venv virtualenv venv
source venv/bin/activate source venv/bin/activate
pip install -e ".[test]" pip install -e ".[test]"
Well-written tests and maintaining good test coverage is important to Well-written tests and maintaining good test coverage is important to
this project. While developing, run new and existing tests with: this project. While developing, run new and existing tests with:
.. code:: sh .. code:: sh
py.test graphene/relay/tests/test_node.py # Single file py.test graphene/relay/tests/test_node.py # Single file
py.test graphene/relay # All tests in directory py.test graphene/relay # All tests in directory
Add the ``-s`` flag if you have introduced breakpoints into the code for Add the ``-s`` flag if you have introduced breakpoints into the code for
debugging. Add the ``-v`` ("verbose") flag to get more detailed test debugging. Add the ``-v`` (“verbose”) flag to get more detailed test
output. For even more detailed output, use ``-vv``. Check out the output. For even more detailed output, use ``-vv``. Check out the
`pytest documentation <https://docs.pytest.org/en/latest/>`__ for more `pytest documentation <https://docs.pytest.org/en/latest/>`__ for more
options and test running controls. options and test running controls.
@ -132,7 +127,7 @@ You can also run the benchmarks with:
.. code:: sh .. code:: sh
py.test graphene --benchmark-only py.test graphene --benchmark-only
Graphene supports several versions of Python. To make sure that changes Graphene supports several versions of Python. To make sure that changes
do not break compatibility with any of those versions, we use ``tox`` to do not break compatibility with any of those versions, we use ``tox`` to
@ -142,14 +137,14 @@ config file, just run:
.. code:: sh .. code:: sh
tox tox
If you wish to run against a specific version defined in the ``tox.ini`` If you wish to run against a specific version defined in the ``tox.ini``
file: file:
.. code:: sh .. code:: sh
tox -e py36 tox -e py36
Tox can only use whatever versions of Python are installed on your Tox can only use whatever versions of Python are installed on your
system. When you create a pull request, Travis will also be running the system. When you create a pull request, Travis will also be running the
@ -168,7 +163,7 @@ An HTML version of the documentation is produced by running:
.. code:: sh .. code:: sh
make docs make docs
.. |Graphene Logo| image:: http://graphene-python.org/favicon.png .. |Graphene Logo| image:: http://graphene-python.org/favicon.png
.. |Build Status| image:: https://travis-ci.org/graphql-python/graphene.svg?branch=master .. |Build Status| image:: https://travis-ci.org/graphql-python/graphene.svg?branch=master