You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+17-10Lines changed: 17 additions & 10 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -2,15 +2,15 @@
2
2
3
3
[💬 Join the community on Slack](https://join.slack.com/t/graphenetools/shared_invite/enQtOTE2MDQ1NTg4MDM1LTA4Nzk0MGU0NGEwNzUxZGNjNDQ4ZjAwNDJjMjY0OGE1ZDgxZTg4YjM2ZTc4MjE2ZTAzZjE2ZThhZTQzZTkyMmM)
4
4
5
-
**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 ❤️
5
+
**We are looking for contributors**! Please check the current issues to see how you can help ❤️
6
6
7
7
## Introduction
8
8
9
9
[Graphene](http://graphene-python.org) is an opinionated Python library for building GraphQL schemas/types fast and easily.
10
10
11
11
-**Easy to use:** Graphene helps you use GraphQL in Python without effort.
12
12
-**Relay:** Graphene has builtin support for Relay.
13
-
-**Data agnostic:** Graphene supports any kind of data source: SQL (Django, SQLAlchemy), NoSQL, custom Python objects, etc.
13
+
-**Data agnostic:** Graphene supports any kind of data source: SQL (Django, SQLAlchemy), Mongo, custom Python objects, etc.
14
14
We believe that by providing a complete API you could plug Graphene anywhere your data lives and make your data available
15
15
through GraphQL.
16
16
@@ -20,9 +20,10 @@ Graphene has multiple integrations with different frameworks:
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).
28
29
@@ -31,7 +32,7 @@ Also, Graphene is fully compatible with the GraphQL spec, working seamlessly wit
31
32
To install `graphene`, just run this command in your shell
32
33
33
34
```bash
34
-
pip install "graphene>=3.0"
35
+
pip install "graphene>=3.1"
35
36
```
36
37
37
38
## Examples
@@ -84,18 +85,24 @@ pip install -e ".[test]"
84
85
Well-written tests and maintaining good test coverage is important to this project. While developing, run new and existing tests with:
85
86
86
87
```sh
87
-
py.test graphene/relay/tests/test_node.py # Single file
88
-
py.test graphene/relay # All tests in directory
88
+
pytest graphene/relay/tests/test_node.py # Single file
89
+
pytest graphene/relay # All tests in directory
89
90
```
90
91
91
92
Add the `-s` flag if you have introduced breakpoints into the code for debugging.
92
93
Add the `-v` ("verbose") flag to get more detailed test output. For even more detailed output, use `-vv`.
93
94
Check out the [pytest documentation](https://docs.pytest.org/en/latest/) for more options and test running controls.
94
95
96
+
Regularly ensure your `pre-commit` hooks are up to date and enabled:
97
+
98
+
```sh
99
+
pre-commit install
100
+
```
101
+
95
102
You can also run the benchmarks with:
96
103
97
104
```sh
98
-
py.test graphene --benchmark-only
105
+
pytest graphene --benchmark-only
99
106
```
100
107
101
108
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:
@@ -107,10 +114,10 @@ tox
107
114
If you wish to run against a specific version defined in the `tox.ini` file:
108
115
109
116
```sh
110
-
tox -e py36
117
+
tox -e py39
111
118
```
112
119
113
-
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!
120
+
Tox can only use whatever versions of Python are installed on your system. When you create a pull request, GitHub Actions pipelines 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!
0 commit comments