Skip to main content

Ariadne contrib library for working with Django and GraphQL

Project description

Ariadne Extended

Ariadne comes with a few contrib modules to support integration with Django. This module acts as an additional Django contrib module to reduce some of the boilerplate when integrating with Django.

It copies and follows some of the conventions defined in Django Rest Framework, effort will be made to provide API compatibility with certain DRF extension modules that are relevant.

The overall goal is to provide often re-used modules and GrpahQL schema, so one doesn't have to re-create them per project.

Supported DRF modules

  • Pagination classes
  • Permissions classes
  • Serializer classes ( may not removed and made generic )
  • Throttling
  • django-filters filter backend

ariadne_extended.graph

auto schema, resolver and types loader

Searches for types and resolvers modules as well as the schema.graphql defined within every installed Django application.

Once found they can be used to build the final schema and resolver solution for your ariadne application.

ariadne_extended.payload

Schema, types and resolvers for the graphql Payload interface.

Currently the FieldErrors are highly coupled to Django rest framework field validation exceptions.

ariadne_extended.cursor_pagination

Rename to relay_pagination maybe?

Contains the PageInfo graphql type and Connection interface for utilizing cursor based pagination.

TODO: Should we provide a input type for cursor pagination instead of just copying pagination args info paginate-able list fields??

ariadne_extended.filters

Filter backend interface to pass filter arguments to django-filter

ariadne_extended.resolvers

ABC for Class Based Resolvers and model resolvers that utilize DRF serializers for saving data. This is likely to change in the future.

ariadne_extended.uuid

DRF UUID field scalar for use with models that may use a UUID as their primary key, or other UUID fields.

Checklist

  • Get rid of dependency on DRF?
  • Investigate the need for a serializer ( nested data reliance? )
  • Organize code into multiple Django apps to select desired componentry
  • Documentation and examples
  • Better support of lists of enums when used with django-filters ( currently expects comma sep list string, not a list of enums from input field resolver )
  • License and make public
  • Deployment automation

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

ariadne-extended-0.1.2.tar.gz (17.2 kB view details)

Uploaded Source

Built Distribution

ariadne_extended-0.1.2-py3-none-any.whl (21.8 kB view details)

Uploaded Python 3

File details

Details for the file ariadne-extended-0.1.2.tar.gz.

File metadata

  • Download URL: ariadne-extended-0.1.2.tar.gz
  • Upload date:
  • Size: 17.2 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.0.5 CPython/3.7.4 Darwin/19.4.0

File hashes

Hashes for ariadne-extended-0.1.2.tar.gz
Algorithm Hash digest
SHA256 3bd07864b59f266607389e1582b07f6b6b40004f051c78e556044b4d3f714c3c
MD5 bfdc14546cf5b0cdf8cf08436fe3d4da
BLAKE2b-256 0acebbb29b03faa9ab2530d983605f0c2d6fc11908c82367e01564e9bde60b06

See more details on using hashes here.

File details

Details for the file ariadne_extended-0.1.2-py3-none-any.whl.

File metadata

File hashes

Hashes for ariadne_extended-0.1.2-py3-none-any.whl
Algorithm Hash digest
SHA256 8deaae079b548828edfeaa5e7be8a1d55f44036799341bcaa05fcd1788d0db08
MD5 cc08bbf2b1927afe065e0929beddc5f8
BLAKE2b-256 3622d44b24f0b200f2a6715ddbe3201413681e9983b9b6f4535f5b3aef10648c

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page