Skip to content

Commit 20219fd

Browse files
authored
Update README.md
Update
1 parent 45986b1 commit 20219fd

File tree

1 file changed

+17
-10
lines changed

1 file changed

+17
-10
lines changed

README.md

Lines changed: 17 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -2,15 +2,15 @@
22

33
[💬 Join the community on Slack](https://join.slack.com/t/graphenetools/shared_invite/enQtOTE2MDQ1NTg4MDM1LTA4Nzk0MGU0NGEwNzUxZGNjNDQ4ZjAwNDJjMjY0OGE1ZDgxZTg4YjM2ZTc4MjE2ZTAzZjE2ZThhZTQzZTkyMmM)
44

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 ❤️
66

77
## Introduction
88

99
[Graphene](http://graphene-python.org) is an opinionated Python library for building GraphQL schemas/types fast and easily.
1010

1111
- **Easy to use:** Graphene helps you use GraphQL in Python without effort.
1212
- **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.
1414
We believe that by providing a complete API you could plug Graphene anywhere your data lives and make your data available
1515
through GraphQL.
1616

@@ -20,9 +20,10 @@ Graphene has multiple integrations with different frameworks:
2020

2121
| integration | Package |
2222
| ----------------- | --------------------------------------------------------------------------------------- |
23-
| Django | [graphene-django](https://github.com/graphql-python/graphene-django/) |
2423
| SQLAlchemy | [graphene-sqlalchemy](https://github.com/graphql-python/graphene-sqlalchemy/) |
25-
| Google App Engine | [graphene-gae](https://github.com/graphql-python/graphene-gae/) |
24+
| Mongo | [graphene-mongo](https://github.com/graphql-python/graphene-mongo/) |
25+
| Apollo Federation | [graphene-federation](https://github.com/graphql-python/graphene-federation/) |
26+
| Django | [graphene-django](https://github.com/graphql-python/graphene-django/) |
2627

2728
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).
2829

@@ -31,7 +32,7 @@ Also, Graphene is fully compatible with the GraphQL spec, working seamlessly wit
3132
To install `graphene`, just run this command in your shell
3233

3334
```bash
34-
pip install "graphene>=3.0"
35+
pip install "graphene>=3.1"
3536
```
3637

3738
## Examples
@@ -84,18 +85,24 @@ pip install -e ".[test]"
8485
Well-written tests and maintaining good test coverage is important to this project. While developing, run new and existing tests with:
8586

8687
```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
8990
```
9091

9192
Add the `-s` flag if you have introduced breakpoints into the code for debugging.
9293
Add the `-v` ("verbose") flag to get more detailed test output. For even more detailed output, use `-vv`.
9394
Check out the [pytest documentation](https://docs.pytest.org/en/latest/) for more options and test running controls.
9495

96+
Regularly ensure your `pre-commit` hooks are up to date and enabled:
97+
98+
```sh
99+
pre-commit install
100+
```
101+
95102
You can also run the benchmarks with:
96103

97104
```sh
98-
py.test graphene --benchmark-only
105+
pytest graphene --benchmark-only
99106
```
100107

101108
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
107114
If you wish to run against a specific version defined in the `tox.ini` file:
108115

109116
```sh
110-
tox -e py36
117+
tox -e py39
111118
```
112119

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!
114121

115122
### Building Documentation
116123

0 commit comments

Comments
 (0)