Graphene-Django
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.
Features
- 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
Installation
To install Graphene-Django, run the following command:
pip install graphene-django
Configuration
After installation, add 'graphene_django' to your Django project's INSTALLED_APPS list and define the GraphQL schema in your project's settings:
INSTALLED_APPS = [
# ...
'graphene_django',
]
GRAPHENE = {
'SCHEMA': 'myapp.schema.schema'
}
Usage
To use Graphene-Django, create a schema.py file in your Django app directory and define your GraphQL types and queries:
import graphene
from graphene_django import DjangoObjectType
from .models import MyModel
class MyModelType(DjangoObjectType):
class Meta:
model = MyModel
class Query(graphene.ObjectType):
mymodels = graphene.List(MyModelType)
def resolve_mymodels(self, info, **kwargs):
return MyModel.objects.all()
schema = graphene.Schema(query=Query)
Then, expose the GraphQL API in your Django project's urls.py file:
from django.urls import path
from graphene_django.views import GraphQLView
from . import schema
urlpatterns = [
# ...
path('graphql/', GraphQLView.as_view(graphiql=True)), # Given that schema path is defined in GRAPHENE['SCHEMA'] in your settings.py
]
Testing
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:
from django.test import TestCase
from graphene_django.utils.testing import GraphQLTestCase
from . import schema
class MyModelAPITestCase(GraphQLTestCase):
GRAPHENE_SCHEMA = schema.schema
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
Contributions to Graphene-Django are always welcome! To get started, check the repository's issue tracker and contribution guidelines.
License
Graphene-Django is released under the MIT License.
Resources
- Official GitHub Repository
- Graphene Documentation
- Django Documentation
- GraphQL Specification
- GraphiQL - An in-browser IDE for exploring GraphQL APIs
- Graphene-Django Community - Join the community to discuss questions and share ideas related to Graphene-Django
Tutorials and Examples
- Official Graphene-Django Tutorial
- Building a GraphQL API with Django and Graphene-Django
- Real-world example: Django, Graphene, and Relay
Related Projects
- Graphene - A library for building GraphQL APIs in Python
- Graphene-SQLAlchemy - Integration between Graphene and SQLAlchemy, an Object Relational Mapper (ORM) for Python
- Graphene-File-Upload - A package providing an Upload scalar for handling file uploads in Graphene
- 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 on the official GitHub repository. You can also ask for help and share your experiences with the Graphene-Django community on 💬 Discord
Release Notes
3 maintainers
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file graphene-django-3.2.3.tar.gz.
File metadata
- Download URL: graphene-django-3.2.3.tar.gz
- Upload date:
- Size: 88.4 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/6.1.0 CPython/3.12.9
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
d831bfe8e9a6e77e477b7854faef4addb318f386119a69ee4c57b74560f3e07d
|
|
| MD5 |
8b371b17aa23c66b2be7fd9553aef4df
|
|
| BLAKE2b-256 |
6f7a8aef131349329dcd167578720f6364412f1728bfda14bba22c1e7b5d8365
|
File details
Details for the file graphene_django-3.2.3-py2.py3-none-any.whl.
File metadata
- Download URL: graphene_django-3.2.3-py2.py3-none-any.whl
- Upload date:
- Size: 115.0 kB
- Tags: Python 2, Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/6.1.0 CPython/3.12.9
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
0c673a4dad315b26b4d18eb379ad0c7027fd6a36d23a1848b7c7c09a14a9271e
|
|
| MD5 |
4e9be1b4f9dd86b8b3cdb9d9a0aef251
|
|
| BLAKE2b-256 |
1835ab9c668222f6271a0b71efb147c46816229dbb9fa5d15ee6b025eb08d4b2
|
