Skip to main content

A Python implementation of GraphQL designed for use with Django

Project description

This is an implementation of GraphQL in Python, designed to work with the Django web framework. The project began at DjangoCon US 2017.

Why Django Graph API?

We see GraphQL as a promising alternative to REST.

In order to increase its usage amongst Python developers, we are trying to create a library that stays up to date with the GraphQL specs and that embraces all of the things we love about Python:

  • simple, readable, and elegant

  • great documentation

  • supportive open-source community

Contributing

We welcome contributions! We use Github projects to organize our ticket workflow. If there’s a particular issue you would like to work on and it isn’t already assigned, feel free to assign it to yourself and start work! If you just want to lend a hand, check out the current project and choose one of the tickets from the backlog!

Once you’re done writing code, you will need to open a pull request with your changes. In order to be merged, pull requests must fulfill the following requirements:

  • All new code must have tests.

  • All tests must be passing.

  • Any relevant documentation has been updated.

If you need help with something, that’s totally fine. Do what you can and then ask for what you need! Just be aware that there may be a delay before someone comes along who has time to provide it.

Once your pull request is complete, one of the core contributors will review it and give feedback or merge as appropriate.

To run the tests, run pytest.

If you have any questions or want to start contributing, chat with us on Slack.

Code of conduct

This project adheres to and supports the Django Code of Conduct.

Style guide

This project uses the Django coding style guide.

Documentation

You can find the full documentation for Django Graph API on ReadTheDocs.

To create the docs locally, navigate to the docs directory, install the docs requirements, then build the docs files as html:

cd docs
pip install -r requirements.txt
make html

The resulting index.html file will be in _build/html/.

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

django-graph-api-0.2.0.tar.gz (14.8 kB view details)

Uploaded Source

Built Distribution

django_graph_api-0.2.0-py2.py3-none-any.whl (19.0 kB view details)

Uploaded Python 2 Python 3

File details

Details for the file django-graph-api-0.2.0.tar.gz.

File metadata

File hashes

Hashes for django-graph-api-0.2.0.tar.gz
Algorithm Hash digest
SHA256 ca378844c05cecf51bf2329650d301a93f3f25c2d412bd08b44a43b145fb9929
MD5 d96cf45475b36df27c5fc200f3dbf65a
BLAKE2b-256 ce929679901cbe74bd4f2c87086ff186686905a924368c742f12a4038b681fc0

See more details on using hashes here.

File details

Details for the file django_graph_api-0.2.0-py2.py3-none-any.whl.

File metadata

File hashes

Hashes for django_graph_api-0.2.0-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 17ea86bc7555e9ba21118e8b24e76495fe05307bf2bc62392fea302d77728373
MD5 7ad89188d23204155436c574acc5801e
BLAKE2b-256 7dd5414d4f24c530831c3b1076a07e1468e4b2d3cc79a218ad383b11e8a74b58

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