A Wagtail package that speeds up and simplifies implementing a GraphQL endpoint!
Project description
Wagtail Grapple
A library to build GraphQL endpoints easily so you can grapple your Wagtail data from anywhere!
Explore the docs » · Report Bug · Request Feature
About The Project
There is a range of GraphQL packages for Python and specifically Django. However, getting these packages to work out of the box with an existing infrastructure without errors isn't as easy to come by.
The purpose of Grapple is to be able to build GraphQL endpoints on a model by model
basis as quickly as possible. The setup and configuration have been designed
to be as simple but also provide the best features;
No complex serializers need to be written - just add a graphql_fields list
to your model and away you go (although if you want to go deeper you can!).
Features
- Easily create GraphQL types by adding a small annotation in your models.
- Supports traditional Wagtail models:
- Pages (including StreamField & Orderables)
- Snippets
- Images
- Documents
- Media (via wagtailmedia)
- Settings
- Redirects
- Search (on all models)
- Custom Image & Document model support
- Pagination support
- Middleware support
Built With
This library is an abstraction upon and relies heavily on Graphene & Graphene Django.
Getting Started
Getting Grapple installed is designed to be as simple as possible!
Prerequisites
Python >= 3.8
Wagtail >= 4.1
Installation
Install using pip
python -m pip install wagtail_grapple
Add the following to the INSTALLED_APPS list in your Wagtail settings file:
INSTALLED_APPS = [
# ...
"grapple",
"graphene_django",
# ...
]
Add the following to the bottom of the same settings file, where each key is the app you want to this library to scan and the value is the prefix you want to give to GraphQL types (you can usually leave this blank):
# Grapple config:
GRAPHENE = {"SCHEMA": "grapple.schema.schema"}
GRAPPLE = {
"APPS": ["home"],
}
Add the GraphQL URLs to your urls.py:
from django.urls import include, path
from grapple import urls as grapple_urls
# ...
urlpatterns = [
# ...
path("api/", include(grapple_urls)),
# ...
]
Done! Now you can proceed onto configuring your models to generate GraphQL types that adopt their structure :tada: Your GraphQL endpoint is available at http://localhost:8000/api/graphql/
Usage
Here is a GraphQL model configuration for the default page from the Wagtail docs:
# ...
from grapple.models import GraphQLString, GraphQLStreamfield
class BlogPage(Page):
author = models.CharField(max_length=255)
date = models.DateField("Post date")
body = StreamField(
[
("heading", blocks.CharBlock(classname="full title")),
("paragraph", blocks.RichTextBlock()),
("image", ImageChooserBlock()),
]
)
content_panels = Page.content_panels + [
FieldPanel("author"),
FieldPanel("date"),
StreamFieldPanel("body"),
]
# Note these fields below:
graphql_fields = [
GraphQLString("heading"),
GraphQLString("date"),
GraphQLString("author"),
GraphQLStreamfield("body"),
]
For more examples, please refer to the Documentation
Contributing
Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.
- Fork the project
- Create your feature branch (
git checkout -b feature/amazing-feature) - Commit your changes (
git commit -m 'Add some amazing feature') - Push to the branch (
git push origin feature/amazing-feature) - Open a Pull Request
Local development
- In the Python environment of your choice, navigate to
tests/ - Run
python -m pip install -r requirements.txt - Run
python manage.py migrate - Run server
python manage.py runserver - Run tests
python manage.py test
With Postgres
- Ensure you have docker and docker compose
- Run
docker compose up - Run
export DATABASE_URL="postgres://postgres:postgres@localhost/postgres" - In the Python environment of your choice, navigate to
tests/ - Run
python -m pip install -r requirements.txt - Run
python manage.py migrate - Run server
python manage.py runserver - Run tests
python manage.py test
Compatibility
Wagtail Grapple supports:
- Python 3.8, 3.9, 3.10 and 3.11
- Wagtail >= 4.1
License
Distributed under the MIT License. See LICENSE for more information.
Inspired by
Release history Release notifications | RSS feed
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
File details
Details for the file wagtail_grapple-0.23.0.tar.gz.
File metadata
- Download URL: wagtail_grapple-0.23.0.tar.gz
- Upload date:
- Size: 38.1 kB
- Tags: Source
- Uploaded using Trusted Publishing? Yes
- Uploaded via: twine/4.0.2 CPython/3.11.5
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 11bd295696935e1e99e467af1c55bb03f6ce508b7b355d1d84d24ba2956976b2 |
|
| MD5 | 6bee23887a2a8cd2e7a4ce01df2e984d |
|
| BLAKE2b-256 | 47c8933bdf98bc2c7ae24a0d46750da3c1c2208dbdca6316630a0721b469e0e8 |
Provenance
File details
Details for the file wagtail_grapple-0.23.0-py3-none-any.whl.
File metadata
- Download URL: wagtail_grapple-0.23.0-py3-none-any.whl
- Upload date:
- Size: 47.2 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? Yes
- Uploaded via: twine/4.0.2 CPython/3.11.5
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 03aa64b1ede13cff07e5d73687b5b80f916eef5981afeb46bd26f48ab9bb0983 |
|
| MD5 | 59b5ccdaa1a6d43d28730081e4a2dcdd |
|
| BLAKE2b-256 | 1ea0b32f7d7fb5eb53e697ed3b0856b25e84cbd3a23332a8aa4348c007aea45c |
