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_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.

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

Uploaded Source

Built Distribution

ariadne_extended-0.1.7-py3-none-any.whl (21.6 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: ariadne-extended-0.1.7.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.7.tar.gz
Algorithm Hash digest
SHA256 d7a2d5b00a770fcc6c6fd97ec6e94fbd42f62db606b6e414270256c7036e1f8e
MD5 5cd5d5f49396bf84fbb37f6146c88c48
BLAKE2b-256 dd1c38e37c84c5bcf3a2099d3494b4b83892ded594accb4462a567453c6446a6

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for ariadne_extended-0.1.7-py3-none-any.whl
Algorithm Hash digest
SHA256 4f6b013e31731230361ad957dc2bce4242077ec67c2449264ee61f957abbe2f6
MD5 841011c1e8ead4cc28871d2c8869ba67
BLAKE2b-256 e2267439821d622e583cf7608af9c8ba387d12ed7b290b0bb34325a1bfd8aa3d

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