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

Supported Django versions

2.2.*, 3.0.*

ariadne_extended.graph_loader

auto schema, resolver and types loader

Searches for types and resolvers modules as well as any .graphql files defined within any 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.

Contrib

django-waffle in ariadne_extended.contrib.waffle_graph

Adds resolvers, schema and types that can be utilized to query the any waffle flags, samples and switches.

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
  • Mixins are highly coupled to serializers, should they still be?

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.2.0.tar.gz (20.2 kB view details)

Uploaded Source

Built Distribution

ariadne_extended-0.2.0-py3-none-any.whl (25.6 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: ariadne-extended-0.2.0.tar.gz
  • Upload date:
  • Size: 20.2 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.0.9 CPython/3.8.3 Darwin/19.6.0

File hashes

Hashes for ariadne-extended-0.2.0.tar.gz
Algorithm Hash digest
SHA256 76b8f4875c7847b07a377b20b6f67072d187e6e33287cfcea39c9c3e64ecd3bf
MD5 dcf55791394ea07beb36fa8c929897bb
BLAKE2b-256 09d4e4b84b652a5cab2c4028e027edbce0c75157629f6d8a38db666d5885c00c

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for ariadne_extended-0.2.0-py3-none-any.whl
Algorithm Hash digest
SHA256 44640aaed35ca6bf4dc8c4e2b97f5ab3c05a063fd2dda252539544353295d4cd
MD5 ca6364906809ea77e2c875c9897396f8
BLAKE2b-256 882aee0fd18c4b70f8f4614d8a747339be9214392671c2046ffa11d26124f5cf

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