mirror of
https://github.com/graphql-python/graphene.git
synced 2024-11-24 10:33:59 +03:00
131 lines
5.0 KiB
Markdown
131 lines
5.0 KiB
Markdown
#  [Graphene](http://graphene-python.org) [](https://badge.fury.io/py/graphene) [](https://coveralls.io/github/graphql-python/graphene?branch=master) [](https://discord.gg/T6Gp6NFYHe)
|
|
|
|
[💬 Join the community on Discord](https://discord.gg/T6Gp6NFYHe)
|
|
|
|
**We are looking for contributors**! Please check the current issues to see how you can help ❤️
|
|
|
|
## Introduction
|
|
|
|
[Graphene](http://graphene-python.org) is an opinionated Python library for building GraphQL schemas/types fast and easily.
|
|
|
|
- **Easy to use:** Graphene helps you use GraphQL in Python without effort.
|
|
- **Relay:** Graphene has builtin support for Relay.
|
|
- **Data agnostic:** Graphene supports any kind of data source: SQL (Django, SQLAlchemy), Mongo, custom Python objects, etc.
|
|
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 |
|
|
| ----------------- | --------------------------------------------------------------------------------------- |
|
|
| SQLAlchemy | [graphene-sqlalchemy](https://github.com/graphql-python/graphene-sqlalchemy/) |
|
|
| Mongo | [graphene-mongo](https://github.com/graphql-python/graphene-mongo/) |
|
|
| Apollo Federation | [graphene-federation](https://github.com/graphql-python/graphene-federation/) |
|
|
| Django | [graphene-django](https://github.com/graphql-python/graphene-django/) |
|
|
|
|
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).
|
|
|
|
## Installation
|
|
|
|
To install `graphene`, just run this command in your shell
|
|
|
|
```bash
|
|
pip install "graphene>=3.1"
|
|
```
|
|
|
|
## Examples
|
|
|
|
Here is one example for you to get started:
|
|
|
|
```python
|
|
import graphene
|
|
|
|
class Query(graphene.ObjectType):
|
|
hello = graphene.String(description='A typical hello world')
|
|
|
|
def resolve_hello(self, info):
|
|
return 'World'
|
|
|
|
schema = graphene.Schema(query=Query)
|
|
```
|
|
|
|
Then Querying `graphene.Schema` is as simple as:
|
|
|
|
```python
|
|
query = '''
|
|
query SayHello {
|
|
hello
|
|
}
|
|
'''
|
|
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)
|
|
|
|
## Documentation
|
|
|
|
Documentation and links to additional resources are available at
|
|
https://docs.graphene-python.org/en/latest/
|
|
|
|
## Contributing
|
|
|
|
After cloning this repo, create a [virtualenv](https://virtualenv.pypa.io/en/stable/) and ensure dependencies are installed by running:
|
|
|
|
```sh
|
|
virtualenv venv
|
|
source venv/bin/activate
|
|
pip install -e ".[test]"
|
|
```
|
|
|
|
Well-written tests and maintaining good test coverage is important to this project. While developing, run new and existing tests with:
|
|
|
|
```sh
|
|
pytest graphene/relay/tests/test_node.py # Single file
|
|
pytest graphene/relay # 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.
|
|
|
|
Regularly ensure your `pre-commit` hooks are up to date and enabled:
|
|
|
|
```sh
|
|
pre-commit install
|
|
```
|
|
|
|
You can also run the benchmarks with:
|
|
|
|
```sh
|
|
pytest 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 py39
|
|
```
|
|
|
|
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!
|
|
|
|
### Building Documentation
|
|
|
|
The documentation is generated using the excellent [Sphinx](http://www.sphinx-doc.org/) and a custom theme.
|
|
|
|
An HTML version of the documentation is produced by running:
|
|
|
|
```sh
|
|
make docs
|
|
```
|