graphql-python/graphene-django
1
1
Fork 0
mirror of https://github.com/graphql-python/graphene-django.git synced 2024-11-13 05:07:02 +03:00
Code Issues Packages Projects Releases Wiki Activity

Update README.md (#1408)

Browse Source 
* Update README.md

* Delete README.rst

* Update long_description source to be from README.md
This commit is contained in:
Firas Kafri 2023-05-04 23:54:09 +03:00 committed by GitHub
parent ce7492b5ae
commit 6f13d28b6e
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
2 changed files with 92 additions and 65 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

155
README.md
View File

@ -1,8 +1,5 @@
# ![Graphene Logo](http://graphene-python.org/favicon.png) Graphene-Django # ![Graphene Logo](http://graphene-python.org/favicon.png) Graphene-Django
A [Django](https://www.djangoproject.com/) integration for [Graphene](http://graphene-python.org/).
[![build][build-image]][build-url] [![build][build-image]][build-url]
[![pypi][pypi-image]][pypi-url] [![pypi][pypi-image]][pypi-url]
[![Anaconda-Server Badge][conda-image]][conda-url] [![Anaconda-Server Badge][conda-image]][conda-url]
@ -17,107 +14,137 @@ A [Django](https://www.djangoproject.com/) integration for [Graphene](http://gra
[conda-image]: https://img.shields.io/conda/vn/conda-forge/graphene-django.svg [conda-image]: https://img.shields.io/conda/vn/conda-forge/graphene-django.svg
[conda-url]: https://anaconda.org/conda-forge/graphene-django [conda-url]: https://anaconda.org/conda-forge/graphene-django
[💬 Join the community on Slack](https://join.slack.com/t/graphenetools/shared_invite/enQtOTE2MDQ1NTg4MDM1LTA4Nzk0MGU0NGEwNzUxZGNjNDQ4ZjAwNDJjMjY0OGE1ZDgxZTg4YjM2ZTc4MjE2ZTAzZjE2ZThhZTQzZTkyMmM) Graphene-Django is an open-source library that provides seamless integration between Django, a high-level Python web framework, and Graphene, a library for building GraphQL APIs. The library allows developers to create GraphQL APIs in Django quickly and efficiently while maintaining a high level of performance.
## Documentation ## Features
[Visit the documentation to get started!](https://docs.graphene-python.org/projects/django/en/latest/) * Seamless integration with Django models
* Automatic generation of GraphQL schema
* Integration with Django's authentication and permission system
* Easy querying and filtering of data
* Support for Django's pagination system
* Compatible with Django's form and validation system
* Extensive documentation and community support
## Quickstart ## Installation
For installing graphene, just run this command in your shell To install Graphene-Django, run the following command:
```bash ```
pip install "graphene-django>=3" pip install graphene-django
``` ```
### Settings ## Configuration
After installation, add 'graphene_django' to your Django project's `INSTALLED_APPS` list and define the GraphQL schema in your project's settings:
```python ```python
INSTALLED_APPS = ( INSTALLED_APPS = [
# ... # ...
'django.contrib.staticfiles', # Required for GraphiQL
'graphene_django', 'graphene_django',
) ]
GRAPHENE = { GRAPHENE = {
'SCHEMA': 'app.schema.schema' # Where your Graphene schema lives 'SCHEMA': 'myapp.schema.schema'
} }
``` ```
### Urls ## Usage
We need to set up a `GraphQL` endpoint in our Django app, so we can serve the queries. To use Graphene-Django, create a `schema.py` file in your Django app directory and define your GraphQL types and queries:
```python ```python
from django.urls import path
from graphene_django.views import GraphQLView
urlpatterns = [
# ...
path('graphql/', GraphQLView.as_view(graphiql=True)),
]
```
## Examples
Here is a simple Django model:
```python
from django.db import models
class UserModel(models.Model):
name = models.CharField(max_length=100)
last_name = models.CharField(max_length=100)
```
To create a GraphQL schema for it you simply have to write the following:
```python
from graphene_django import DjangoObjectType
import graphene import graphene
from graphene_django import DjangoObjectType
from .models import MyModel
class User(DjangoObjectType): class MyModelType(DjangoObjectType):
class Meta: class Meta:
model = UserModel model = MyModel
class Query(graphene.ObjectType): class Query(graphene.ObjectType):
users = graphene.List(User) mymodels = graphene.List(MyModelType)
def resolve_users(self, info): def resolve_mymodels(self, info, **kwargs):
return UserModel.objects.all() return MyModel.objects.all()
schema = graphene.Schema(query=Query) schema = graphene.Schema(query=Query)
``` ```
Then you can query the schema: Then, expose the GraphQL API in your Django project's `urls.py` file:
```python ```python
query = ''' from django.urls import path
query { from graphene_django.views import GraphQLView
users { from . import schema
name,
lastName urlpatterns = [
} # ...
} path('graphql/', GraphQLView.as_view(graphiql=True)), # Given that schema path is defined in GRAPHENE['SCHEMA'] in your settings.py
''' ]
result = schema.execute(query)
``` ```
To learn more check out the following [examples](examples/): ## Testing
* **Schema with Filtering**: [Cookbook example](examples/cookbook) Graphene-Django provides support for testing GraphQL APIs using Django's test client. To create tests, create a `tests.py` file in your Django app directory and write your test cases:
* **Relay Schema**: [Starwars Relay example](examples/starwars)
```python
from django.test import TestCase
from graphene_django.utils.testing import GraphQLTestCase
from . import schema
## GraphQL testing clients class MyModelAPITestCase(GraphQLTestCase):
- [Firecamp](https://firecamp.io/graphql) GRAPHENE_SCHEMA = schema.schema
- [GraphiQL](https://github.com/graphql/graphiql)
def test_query_all_mymodels(self):
response = self.query(
'''
query {
mymodels {
id
name
}
}
'''
)
self.assertResponseNoErrors(response)
self.assertEqual(len(response.data['mymodels']), MyModel.objects.count())
```
## Contributing ## Contributing
See [CONTRIBUTING.md](CONTRIBUTING.md) Contributions to Graphene-Django are always welcome! To get started, check the repository's [issue tracker](https://github.com/graphql-python/graphene-django/issues) and [contribution guidelines](https://github.com/graphql-python/graphene-django/blob/master/CONTRIBUTING.md).
## License
Graphene-Django is released under the [MIT License](https://github.com/graphql-python/graphene-django/blob/master/LICENSE).
## Resources
* [Official GitHub Repository](https://github.com/graphql-python/graphene-django)
* [Graphene Documentation](http://docs.graphene-python.org/en/latest/)
* [Django Documentation](https://docs.djangoproject.com/en/stable/)
* [GraphQL Specification](https://spec.graphql.org/)
* [GraphiQL](https://github.com/graphql/graphiql) - An in-browser IDE for exploring GraphQL APIs
* [Graphene-Django Community](https://spectrum.chat/graphene) - Join the community to discuss questions and share ideas related to Graphene-Django
## Tutorials and Examples
* [Official Graphene-Django Tutorial](https://docs.graphene-python.org/projects/django/en/latest/tutorial-plain/)
* [Building a GraphQL API with Django and Graphene-Django](https://www.howtographql.com/graphql-python/0-introduction/)
* [Real-world example: Django, Graphene, and Relay](https://github.com/graphql-python/swapi-graphene)
## Related Projects
* [Graphene](https://github.com/graphql-python/graphene) - A library for building GraphQL APIs in Python
* [Graphene-SQLAlchemy](https://github.com/graphql-python/graphene-sqlalchemy) - Integration between Graphene and SQLAlchemy, an Object Relational Mapper (ORM) for Python
* [Graphene-File-Upload](https://github.com/lmcgartland/graphene-file-upload) - A package providing an Upload scalar for handling file uploads in Graphene
* [Graphene-Subscriptions](https://github.com/graphql-python/graphene-subscriptions) - A package for adding real-time subscriptions to Graphene-based GraphQL APIs
## Support
If you encounter any issues or have questions regarding Graphene-Django, feel free to [submit an issue](https://github.com/graphql-python/graphene-django/issues/new) on the official GitHub repository. You can also ask for help and share your experiences with the Graphene-Django community on [💬 Discord](https://discord.gg/Fftt273T79)
## Release Notes ## Release Notes

2
setup.py
View File

@ -37,7 +37,7 @@ setup(
name="graphene-django", name="graphene-django",
version=version, version=version,
description="Graphene Django integration", description="Graphene Django integration",
long_description=open("README.rst").read(), long_description=open("README.md").read(),
url="https://github.com/graphql-python/graphene-django", url="https://github.com/graphql-python/graphene-django",
author="Syrus Akbary", author="Syrus Akbary",
author_email="me@syrusakbary.com", author_email="me@syrusakbary.com",