graphql-python/graphene
1
1
Fork 0
mirror of https://github.com/graphql-python/graphene.git synced 2025-04-25 12:03:41 +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

47
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
-------- --------
@ -123,7 +118,7 @@ this project. While developing, run new and existing tests with:
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.