mirror of
https://github.com/graphql-python/graphene.git
synced 2024-11-26 03:23:55 +03:00
Added ROADMAP to the Project
This commit is contained in:
Syrus Akbary
parent
c40ce98bb8
commit
bf3a4a88a4
28
README.md
28
README.md
|
|
@ -1,10 +1,9 @@
|
|||
Please read [UPGRADE-v2.0.md](/UPGRADE-v2.0.md) to learn how to upgrade to Graphene `2.0`.
|
||||
**We are looking for contributors**! Please check the [ROADMAP](https://github.com/graphql-python/graphene/blob/master/ROADMAP.md) to see how you can help ❤️
|
||||
|
||||
---
|
||||
|
||||
#  [Graphene](http://graphene-python.org) [](https://travis-ci.org/graphql-python/graphene) [](https://badge.fury.io/py/graphene) [](https://coveralls.io/github/graphql-python/graphene?branch=master)
|
||||
|
||||
|
||||
[Graphene](http://graphene-python.org) is a Python library for building GraphQL schemas/types fast and easily.
|
||||
|
||||
- **Easy to use:** Graphene helps you use GraphQL in Python without effort.
|
||||
|
|
@ -13,17 +12,16 @@ Please read [UPGRADE-v2.0.md](/UPGRADE-v2.0.md) to learn how to upgrade to Graph
|
|||
We believe that by providing a complete API you could plug Graphene anywhere your data lives and make your data available
|
||||
through GraphQL.
|
||||
|
||||
|
||||
## Integrations
|
||||
|
||||
Graphene has multiple integrations with different frameworks:
|
||||
|
||||
| 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)) |
|
||||
| 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)) |
|
||||
|
||||
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).
|
||||
|
||||
|
|
@ -39,7 +37,6 @@ pip install "graphene>=2.0"
|
|||
|
||||
Please read [UPGRADE-v2.0.md](/UPGRADE-v2.0.md) to learn how to upgrade.
|
||||
|
||||
|
||||
## Examples
|
||||
|
||||
Here is one example for you to get started:
|
||||
|
|
@ -67,9 +64,8 @@ result = schema.execute(query)
|
|||
|
||||
If you want to learn even more, you can also check the following [examples](examples/):
|
||||
|
||||
* **Basic Schema**: [Starwars example](examples/starwars)
|
||||
* **Relay Schema**: [Starwars Relay example](examples/starwars_relay)
|
||||
|
||||
- **Basic Schema**: [Starwars example](examples/starwars)
|
||||
- **Relay Schema**: [Starwars Relay example](examples/starwars_relay)
|
||||
|
||||
## Contributing
|
||||
|
||||
|
|
@ -90,7 +86,7 @@ py.test PATH/TO/MY/DIR/ # All tests in directory
|
|||
|
||||
Add the `-s` flag if you have introduced breakpoints into the code for debugging.
|
||||
Add the `-v` ("verbose") flag to get more detailed test output. For even more detailed output, use `-vv`.
|
||||
Check out the [pytest documentation](https://docs.pytest.org/en/latest/) for more options and test running controls.
|
||||
Check out the [pytest documentation](https://docs.pytest.org/en/latest/) for more options and test running controls.
|
||||
|
||||
You can also run the benchmarks with:
|
||||
|
||||
|
|
@ -99,13 +95,17 @@ py.test graphene --benchmark-only
|
|||
```
|
||||
|
||||
Graphene supports several versions of Python. To make sure that changes do not break compatibility with any of those versions, we use `tox` to create virtualenvs for each python version and run tests with that version. To run against all python versions defined in the `tox.ini` config file, just run:
|
||||
|
||||
```sh
|
||||
tox
|
||||
```
|
||||
|
||||
If you wish to run against a specific version defined in the `tox.ini` file:
|
||||
|
||||
```sh
|
||||
tox -e py36
|
||||
```
|
||||
|
||||
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 same tests and report the results, so there is no need for potential contributors to try to install every single version of python on their own system ahead of time. We appreciate opening issues and pull requests to make graphene even more stable & useful!
|
||||
|
||||
### Documentation
|
||||
|
|
|
|||
47
README.rst
47
README.rst
|
|
@ -1,5 +1,6 @@
|
|||
Please read `UPGRADE-v2.0.md </UPGRADE-v2.0.md>`__ to learn how to
|
||||
upgrade to Graphene ``2.0``.
|
||||
**We are looking for contributors**! Please check the
|
||||
`ROADMAP <https://github.com/graphql-python/graphene/blob/master/ROADMAP.md>`__
|
||||
to see how you can help ❤️
|
||||
|
||||
--------------
|
||||
|
||||
|
|
@ -91,17 +92,29 @@ If you want to learn even more, you can also check the following
|
|||
Contributing
|
||||
------------
|
||||
|
||||
After cloning this repo, ensure dependencies are installed by running:
|
||||
After cloning this repo, create a
|
||||
`virtualenv <https://virtualenv.pypa.io/en/stable/>`__ and ensure
|
||||
dependencies are installed by running:
|
||||
|
||||
.. code:: sh
|
||||
|
||||
virtualenv venv
|
||||
source venv/bin/activate
|
||||
pip install -e ".[test]"
|
||||
|
||||
After developing, the full test suite can be evaluated by running:
|
||||
Well-written tests and maintaining good test coverage is important to
|
||||
this project. While developing, run new and existing tests with:
|
||||
|
||||
.. code:: sh
|
||||
|
||||
py.test graphene --cov=graphene --benchmark-skip # Use -v -s for verbose mode
|
||||
py.test PATH/TO/MY/DIR/test_test.py # Single file
|
||||
py.test PATH/TO/MY/DIR/ # All tests in directory
|
||||
|
||||
Add the ``-s`` flag if you have introduced breakpoints into the code for
|
||||
debugging. Add the ``-v`` ("verbose") flag to get more detailed test
|
||||
output. For even more detailed output, use ``-vv``. Check out the
|
||||
`pytest documentation <https://docs.pytest.org/en/latest/>`__ for more
|
||||
options and test running controls.
|
||||
|
||||
You can also run the benchmarks with:
|
||||
|
||||
|
|
@ -109,6 +122,30 @@ You can also run the benchmarks with:
|
|||
|
||||
py.test graphene --benchmark-only
|
||||
|
||||
Graphene supports several versions of Python. To make sure that changes
|
||||
do not break compatibility with any of those versions, we use ``tox`` to
|
||||
create virtualenvs for each python version and run tests with that
|
||||
version. To run against all python versions defined in the ``tox.ini``
|
||||
config file, just run:
|
||||
|
||||
.. code:: sh
|
||||
|
||||
tox
|
||||
|
||||
If you wish to run against a specific version defined in the ``tox.ini``
|
||||
file:
|
||||
|
||||
.. code:: sh
|
||||
|
||||
tox -e py36
|
||||
|
||||
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
|
||||
same tests and report the results, so there is no need for potential
|
||||
contributors to try to install every single version of python on their
|
||||
own system ahead of time. We appreciate opening issues and pull requests
|
||||
to make graphene even more stable & useful!
|
||||
|
||||
Documentation
|
||||
~~~~~~~~~~~~~
|
||||
|
||||
|
|
|
|||
33
ROADMAP.md
Normal file
33
ROADMAP.md
Normal file
|
|
@ -0,0 +1,33 @@
|
|||
# Graphene Roadmap
|
||||
|
||||
In order to move Graphene and the GraphQL Python ecosystem forward I realized is essential to be clear with the community on next steps, so we can move uniformly.
|
||||
|
||||
There are few key points that need to happen in the short/mid term, divided into two main sections:
|
||||
|
||||
- [Community](#community)
|
||||
- [Graphene 3](#graphene-3)
|
||||
|
||||
_👋 If you have more ideas on how to move the Graphene ecosystem forward, don't hesistate to [open a PR](https://github.com/graphql-python/graphene/edit/master/ROADMAP.md)_
|
||||
|
||||
## Community
|
||||
|
||||
The goal is to improve adoption and sustainability of the project.
|
||||
|
||||
- 💎 Add Commercial Support for Graphene #813
|
||||
- Create Patreon page
|
||||
- Add /support page in Graphene website
|
||||
- 📘 Vastly improve documentation #823
|
||||
- 💰 Apply for [Mozilla MOSS](https://www.mozilla.org/en-US/moss/) sponsorship
|
||||
|
||||
## Graphene 3
|
||||
|
||||
The goal is to summarize the different improvements that Graphene will need to accomplish for version 3.
|
||||
|
||||
In a nushell, Graphene 3 should take the Python 3 integration one step forward while still maintaining compatibility with Python 2.
|
||||
|
||||
- 🚀 [graphql-core-next](https://github.com/graphql-python/graphql-core-next) GraphQL engine support (almost same API as graphql-core)
|
||||
- 🔸 GraphQL types from type annotations #729
|
||||
- 📄 Schema creation from SDL (API TBD)
|
||||
- ✨ Improve connections structure
|
||||
- 📗 Improve function documentation
|
||||
- 🔀 Add support for coroutines in Connection, Mutation (abstracting out Promise requirement)
|
||||
Loading…
Reference in New Issue
Block a user