From 1f3fbe0e76bc1c58909ea40175754fa33f1bf951 Mon Sep 17 00:00:00 2001 From: Syrus Akbary Date: Tue, 20 Sep 2016 22:30:36 -0700 Subject: [PATCH] Added first version of the docs --- docs/Makefile | 225 +++++++++++++++++++++ docs/authorization.rst | 111 +++++++++++ docs/conf.py | 444 +++++++++++++++++++++++++++++++++++++++++ docs/debug.rst | 68 +++++++ docs/filtering.rst | 165 +++++++++++++++ docs/index.rst | 13 ++ docs/introspection.rst | 52 +++++ docs/tutorial.rst | 325 ++++++++++++++++++++++++++++++ 8 files changed, 1403 insertions(+) create mode 100644 docs/Makefile create mode 100644 docs/authorization.rst create mode 100644 docs/conf.py create mode 100644 docs/debug.rst create mode 100644 docs/filtering.rst create mode 100644 docs/index.rst create mode 100644 docs/introspection.rst create mode 100644 docs/tutorial.rst diff --git a/docs/Makefile b/docs/Makefile new file mode 100644 index 0000000..7da67c3 --- /dev/null +++ b/docs/Makefile @@ -0,0 +1,225 @@ +# Makefile for Sphinx documentation +# + +# You can set these variables from the command line. +SPHINXOPTS = +SPHINXBUILD = sphinx-build +PAPER = +BUILDDIR = _build + +# Internal variables. +PAPEROPT_a4 = -D latex_paper_size=a4 +PAPEROPT_letter = -D latex_paper_size=letter +ALLSPHINXOPTS = -d $(BUILDDIR)/doctrees $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) . +# the i18n builder cannot share the environment and doctrees with the others +I18NSPHINXOPTS = $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) . + +.PHONY: help +help: + @echo "Please use \`make ' where is one of" + @echo " html to make standalone HTML files" + @echo " dirhtml to make HTML files named index.html in directories" + @echo " singlehtml to make a single large HTML file" + @echo " pickle to make pickle files" + @echo " json to make JSON files" + @echo " htmlhelp to make HTML files and a HTML help project" + @echo " qthelp to make HTML files and a qthelp project" + @echo " applehelp to make an Apple Help Book" + @echo " devhelp to make HTML files and a Devhelp project" + @echo " epub to make an epub" + @echo " epub3 to make an epub3" + @echo " latex to make LaTeX files, you can set PAPER=a4 or PAPER=letter" + @echo " latexpdf to make LaTeX files and run them through pdflatex" + @echo " latexpdfja to make LaTeX files and run them through platex/dvipdfmx" + @echo " text to make text files" + @echo " man to make manual pages" + @echo " texinfo to make Texinfo files" + @echo " info to make Texinfo files and run them through makeinfo" + @echo " gettext to make PO message catalogs" + @echo " changes to make an overview of all changed/added/deprecated items" + @echo " xml to make Docutils-native XML files" + @echo " pseudoxml to make pseudoxml-XML files for display purposes" + @echo " linkcheck to check all external links for integrity" + @echo " doctest to run all doctests embedded in the documentation (if enabled)" + @echo " coverage to run coverage check of the documentation (if enabled)" + @echo " dummy to check syntax errors of document sources" + +.PHONY: clean +clean: + rm -rf $(BUILDDIR)/* + +.PHONY: html +html: + $(SPHINXBUILD) -b html $(ALLSPHINXOPTS) $(BUILDDIR)/html + @echo + @echo "Build finished. The HTML pages are in $(BUILDDIR)/html." + +.PHONY: dirhtml +dirhtml: + $(SPHINXBUILD) -b dirhtml $(ALLSPHINXOPTS) $(BUILDDIR)/dirhtml + @echo + @echo "Build finished. The HTML pages are in $(BUILDDIR)/dirhtml." + +.PHONY: singlehtml +singlehtml: + $(SPHINXBUILD) -b singlehtml $(ALLSPHINXOPTS) $(BUILDDIR)/singlehtml + @echo + @echo "Build finished. The HTML page is in $(BUILDDIR)/singlehtml." + +.PHONY: pickle +pickle: + $(SPHINXBUILD) -b pickle $(ALLSPHINXOPTS) $(BUILDDIR)/pickle + @echo + @echo "Build finished; now you can process the pickle files." + +.PHONY: json +json: + $(SPHINXBUILD) -b json $(ALLSPHINXOPTS) $(BUILDDIR)/json + @echo + @echo "Build finished; now you can process the JSON files." + +.PHONY: htmlhelp +htmlhelp: + $(SPHINXBUILD) -b htmlhelp $(ALLSPHINXOPTS) $(BUILDDIR)/htmlhelp + @echo + @echo "Build finished; now you can run HTML Help Workshop with the" \ + ".hhp project file in $(BUILDDIR)/htmlhelp." + +.PHONY: qthelp +qthelp: + $(SPHINXBUILD) -b qthelp $(ALLSPHINXOPTS) $(BUILDDIR)/qthelp + @echo + @echo "Build finished; now you can run "qcollectiongenerator" with the" \ + ".qhcp project file in $(BUILDDIR)/qthelp, like this:" + @echo "# qcollectiongenerator $(BUILDDIR)/qthelp/Graphene.qhcp" + @echo "To view the help file:" + @echo "# assistant -collectionFile $(BUILDDIR)/qthelp/Graphene.qhc" + +.PHONY: applehelp +applehelp: + $(SPHINXBUILD) -b applehelp $(ALLSPHINXOPTS) $(BUILDDIR)/applehelp + @echo + @echo "Build finished. The help book is in $(BUILDDIR)/applehelp." + @echo "N.B. You won't be able to view it unless you put it in" \ + "~/Library/Documentation/Help or install it in your application" \ + "bundle." + +.PHONY: devhelp +devhelp: + $(SPHINXBUILD) -b devhelp $(ALLSPHINXOPTS) $(BUILDDIR)/devhelp + @echo + @echo "Build finished." + @echo "To view the help file:" + @echo "# mkdir -p $$HOME/.local/share/devhelp/Graphene" + @echo "# ln -s $(BUILDDIR)/devhelp $$HOME/.local/share/devhelp/Graphene" + @echo "# devhelp" + +.PHONY: epub +epub: + $(SPHINXBUILD) -b epub $(ALLSPHINXOPTS) $(BUILDDIR)/epub + @echo + @echo "Build finished. The epub file is in $(BUILDDIR)/epub." + +.PHONY: epub3 +epub3: + $(SPHINXBUILD) -b epub3 $(ALLSPHINXOPTS) $(BUILDDIR)/epub3 + @echo + @echo "Build finished. The epub3 file is in $(BUILDDIR)/epub3." + +.PHONY: latex +latex: + $(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex + @echo + @echo "Build finished; the LaTeX files are in $(BUILDDIR)/latex." + @echo "Run \`make' in that directory to run these through (pdf)latex" \ + "(use \`make latexpdf' here to do that automatically)." + +.PHONY: latexpdf +latexpdf: + $(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex + @echo "Running LaTeX files through pdflatex..." + $(MAKE) -C $(BUILDDIR)/latex all-pdf + @echo "pdflatex finished; the PDF files are in $(BUILDDIR)/latex." + +.PHONY: latexpdfja +latexpdfja: + $(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex + @echo "Running LaTeX files through platex and dvipdfmx..." + $(MAKE) -C $(BUILDDIR)/latex all-pdf-ja + @echo "pdflatex finished; the PDF files are in $(BUILDDIR)/latex." + +.PHONY: text +text: + $(SPHINXBUILD) -b text $(ALLSPHINXOPTS) $(BUILDDIR)/text + @echo + @echo "Build finished. The text files are in $(BUILDDIR)/text." + +.PHONY: man +man: + $(SPHINXBUILD) -b man $(ALLSPHINXOPTS) $(BUILDDIR)/man + @echo + @echo "Build finished. The manual pages are in $(BUILDDIR)/man." + +.PHONY: texinfo +texinfo: + $(SPHINXBUILD) -b texinfo $(ALLSPHINXOPTS) $(BUILDDIR)/texinfo + @echo + @echo "Build finished. The Texinfo files are in $(BUILDDIR)/texinfo." + @echo "Run \`make' in that directory to run these through makeinfo" \ + "(use \`make info' here to do that automatically)." + +.PHONY: info +info: + $(SPHINXBUILD) -b texinfo $(ALLSPHINXOPTS) $(BUILDDIR)/texinfo + @echo "Running Texinfo files through makeinfo..." + make -C $(BUILDDIR)/texinfo info + @echo "makeinfo finished; the Info files are in $(BUILDDIR)/texinfo." + +.PHONY: gettext +gettext: + $(SPHINXBUILD) -b gettext $(I18NSPHINXOPTS) $(BUILDDIR)/locale + @echo + @echo "Build finished. The message catalogs are in $(BUILDDIR)/locale." + +.PHONY: changes +changes: + $(SPHINXBUILD) -b changes $(ALLSPHINXOPTS) $(BUILDDIR)/changes + @echo + @echo "The overview file is in $(BUILDDIR)/changes." + +.PHONY: linkcheck +linkcheck: + $(SPHINXBUILD) -b linkcheck $(ALLSPHINXOPTS) $(BUILDDIR)/linkcheck + @echo + @echo "Link check complete; look for any errors in the above output " \ + "or in $(BUILDDIR)/linkcheck/output.txt." + +.PHONY: doctest +doctest: + $(SPHINXBUILD) -b doctest $(ALLSPHINXOPTS) $(BUILDDIR)/doctest + @echo "Testing of doctests in the sources finished, look at the " \ + "results in $(BUILDDIR)/doctest/output.txt." + +.PHONY: coverage +coverage: + $(SPHINXBUILD) -b coverage $(ALLSPHINXOPTS) $(BUILDDIR)/coverage + @echo "Testing of coverage in the sources finished, look at the " \ + "results in $(BUILDDIR)/coverage/python.txt." + +.PHONY: xml +xml: + $(SPHINXBUILD) -b xml $(ALLSPHINXOPTS) $(BUILDDIR)/xml + @echo + @echo "Build finished. The XML files are in $(BUILDDIR)/xml." + +.PHONY: pseudoxml +pseudoxml: + $(SPHINXBUILD) -b pseudoxml $(ALLSPHINXOPTS) $(BUILDDIR)/pseudoxml + @echo + @echo "Build finished. The pseudo-XML files are in $(BUILDDIR)/pseudoxml." + +.PHONY: dummy +dummy: + $(SPHINXBUILD) -b dummy $(ALLSPHINXOPTS) $(BUILDDIR)/dummy + @echo + @echo "Build finished. Dummy builder generates no files." diff --git a/docs/authorization.rst b/docs/authorization.rst new file mode 100644 index 0000000..83157f2 --- /dev/null +++ b/docs/authorization.rst @@ -0,0 +1,111 @@ +Authorization in Django +======================= + +There are two main ways you may want to limit access to data when +working with Graphene and Django: limiting which fields are accessible +via GraphQL and limiting which objects a user can access. + +Let's use a simple example model. + +.. code:: python + + from django.db import models + + class Post(models.Model): + name = models.CharField(max_length=100) + content = models.TextField() + published = models.BooleanField(default=False) + owner = models.ForeignKey('auth.User') + +Limiting Field Access +--------------------- + +This is easy, simply use the ``only_fields`` meta attribute. + +.. code:: python + + from graphene import relay + from graphene_django.types import DjangoObjectType + from .models import Post + + class PostNode(DjangoObjectType): + class Meta: + model = Post + only_fields = ('title', 'content') + interfaces = (relay.Node, ) + +Queryset Filtering On Lists +--------------------------- + +In order to filter which objects are available in a queryset-based list, +define a resolve method for that field and return the desired queryset. + +.. code:: python + + from graphene import ObjectType + from graphene_django.filter import DjangoFilterConnectionField + from .models import Post + + class Query(ObjectType): + all_posts = DjangoFilterConnectionField(CategoryNode) + + def resolve_all_posts(self, args, info): + return Post.objects.filter(published=True) + +User-based Queryset Filtering +----------------------------- + +If you are using ``GraphQLView`` you can access Django's request +with the context argument. + +.. code:: python + + from graphene import ObjectType + from graphene_django.filter import DjangoFilterConnectionField + from .models import Post + + class Query(ObjectType): + my_posts = DjangoFilterConnectionField(CategoryNode) + + def resolve_my_posts(self, args, context, info): + # context will reference to the Django request + if not context.user.is_authenticated(): + return [] + else: + return Post.objects.filter(owner=context.user) + +If you're using your own view, passing the request context into the +schema is simple. + +.. code:: python + + result = schema.execute(query, context_value=request) + +Filtering ID-based node access +------------------------------ + +In order to add authorization to id-based node access, we need to add a +method to your ``DjangoObjectType``. + +.. code:: python + + from graphene_django.types import DjangoObjectType + from .models import Post + + class PostNode(DjangoObjectType): + class Meta: + model = Post + only_fields = ('title', 'content') + interfaces = (relay.Node, ) + + @classmethod + def get_node(cls, id, context, info): + try: + post = cls._meta.model.objects.get(id=id) + except cls._meta.model.DoesNotExist: + return None + + if post.published or context.user is post.owner: + return instance + else: + return None diff --git a/docs/conf.py b/docs/conf.py new file mode 100644 index 0000000..20b228c --- /dev/null +++ b/docs/conf.py @@ -0,0 +1,444 @@ +import os + +on_rtd = os.environ.get('READTHEDOCS', None) == 'True' + +# -*- coding: utf-8 -*- +# +# Graphene documentation build configuration file, created by +# sphinx-quickstart on Sun Sep 11 18:30:51 2016. +# +# This file is execfile()d with the current directory set to its +# containing dir. +# +# Note that not all possible configuration values are present in this +# autogenerated file. +# +# All configuration values have a default; values that are commented out +# serve to show the default. + +# If extensions (or modules to document with autodoc) are in another directory, +# add these directories to sys.path here. If the directory is relative to the +# documentation root, use os.path.abspath to make it absolute, like shown here. +# +# import os +# import sys +# sys.path.insert(0, os.path.abspath('.')) + +# -- General configuration ------------------------------------------------ + +# If your documentation needs a minimal Sphinx version, state it here. +# +# needs_sphinx = '1.0' + +# Add any Sphinx extension module names here, as strings. They can be +# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom +# ones. +extensions = [ + 'sphinx.ext.autodoc', + 'sphinx.ext.intersphinx', + 'sphinx.ext.todo', + 'sphinx.ext.coverage', + 'sphinx.ext.viewcode', +] +if not on_rtd: + extensions += [ + 'sphinx.ext.githubpages', + ] + +# Add any paths that contain templates here, relative to this directory. +templates_path = ['_templates'] + +# The suffix(es) of source filenames. +# You can specify multiple suffix as a list of string: +# +# source_suffix = ['.rst', '.md'] +source_suffix = '.rst' + +# The encoding of source files. +# +# source_encoding = 'utf-8-sig' + +# The master toctree document. +master_doc = 'index' + +# General information about the project. +project = u'Graphene Django' +copyright = u'Graphene 2016' +author = u'Syrus Akbary' + +# The version info for the project you're documenting, acts as replacement for +# |version| and |release|, also used in various other places throughout the +# built documents. +# +# The short X.Y version. +version = u'1.0' +# The full version, including alpha/beta/rc tags. +release = u'1.0.dev' + +# The language for content autogenerated by Sphinx. Refer to documentation +# for a list of supported languages. +# +# This is also used if you do content translation via gettext catalogs. +# Usually you set "language" from the command line for these cases. +language = None + +# There are two options for replacing |today|: either, you set today to some +# non-false value, then it is used: +# +# today = '' +# +# Else, today_fmt is used as the format for a strftime call. +# +# today_fmt = '%B %d, %Y' + +# List of patterns, relative to source directory, that match files and +# directories to ignore when looking for source files. +# This patterns also effect to html_static_path and html_extra_path +exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store'] + +# The reST default role (used for this markup: `text`) to use for all +# documents. +# +# default_role = None + +# If true, '()' will be appended to :func: etc. cross-reference text. +# +# add_function_parentheses = True + +# If true, the current module name will be prepended to all description +# unit titles (such as .. function::). +# +# add_module_names = True + +# If true, sectionauthor and moduleauthor directives will be shown in the +# output. They are ignored by default. +# +# show_authors = False + +# The name of the Pygments (syntax highlighting) style to use. +pygments_style = 'sphinx' + +# A list of ignored prefixes for module index sorting. +# modindex_common_prefix = [] + +# If true, keep warnings as "system message" paragraphs in the built documents. +# keep_warnings = False + +# If true, `todo` and `todoList` produce output, else they produce nothing. +todo_include_todos = True + + +# -- Options for HTML output ---------------------------------------------- + +# The theme to use for HTML and HTML Help pages. See the documentation for +# a list of builtin themes. +# +html_theme = 'alabaster' +if on_rtd: + html_theme = 'sphinx_rtd_theme' + + +# Theme options are theme-specific and customize the look and feel of a theme +# further. For a list of options available for each theme, see the +# documentation. +# +# html_theme_options = {} + +# Add any paths that contain custom themes here, relative to this directory. +# html_theme_path = [] + +# The name for this set of Sphinx documents. +# " v documentation" by default. +# +# html_title = u'Graphene v1.0.dev' + +# A shorter title for the navigation bar. Default is the same as html_title. +# +# html_short_title = None + +# The name of an image file (relative to this directory) to place at the top +# of the sidebar. +# +# html_logo = None + +# The name of an image file (relative to this directory) to use as a favicon of +# the docs. This file should be a Windows icon file (.ico) being 16x16 or 32x32 +# pixels large. +# +# html_favicon = None + +# Add any paths that contain custom static files (such as style sheets) here, +# relative to this directory. They are copied after the builtin static files, +# so a file named "default.css" will overwrite the builtin "default.css". +html_static_path = ['_static'] + +# Add any extra paths that contain custom files (such as robots.txt or +# .htaccess) here, relative to this directory. These files are copied +# directly to the root of the documentation. +# +# html_extra_path = [] + +# If not None, a 'Last updated on:' timestamp is inserted at every page +# bottom, using the given strftime format. +# The empty string is equivalent to '%b %d, %Y'. +# +# html_last_updated_fmt = None + +# If true, SmartyPants will be used to convert quotes and dashes to +# typographically correct entities. +# +# html_use_smartypants = True + +# Custom sidebar templates, maps document names to template names. +# +# html_sidebars = {} + +# Additional templates that should be rendered to pages, maps page names to +# template names. +# +# html_additional_pages = {} + +# If false, no module index is generated. +# +# html_domain_indices = True + +# If false, no index is generated. +# +# html_use_index = True + +# If true, the index is split into individual pages for each letter. +# +# html_split_index = False + +# If true, links to the reST sources are added to the pages. +# +# html_show_sourcelink = True + +# If true, "Created using Sphinx" is shown in the HTML footer. Default is True. +# +# html_show_sphinx = True + +# If true, "(C) Copyright ..." is shown in the HTML footer. Default is True. +# +# html_show_copyright = True + +# If true, an OpenSearch description file will be output, and all pages will +# contain a tag referring to it. The value of this option must be the +# base URL from which the finished HTML is served. +# +# html_use_opensearch = '' + +# This is the file name suffix for HTML files (e.g. ".xhtml"). +# html_file_suffix = None + +# Language to be used for generating the HTML full-text search index. +# Sphinx supports the following languages: +# 'da', 'de', 'en', 'es', 'fi', 'fr', 'hu', 'it', 'ja' +# 'nl', 'no', 'pt', 'ro', 'ru', 'sv', 'tr', 'zh' +# +# html_search_language = 'en' + +# A dictionary with options for the search language support, empty by default. +# 'ja' uses this config value. +# 'zh' user can custom change `jieba` dictionary path. +# +# html_search_options = {'type': 'default'} + +# The name of a javascript file (relative to the configuration directory) that +# implements a search results scorer. If empty, the default will be used. +# +# html_search_scorer = 'scorer.js' + +# Output file base name for HTML help builder. +htmlhelp_basename = 'Graphenedoc' + +# -- Options for LaTeX output --------------------------------------------- + +latex_elements = { + # The paper size ('letterpaper' or 'a4paper'). + # + # 'papersize': 'letterpaper', + + # The font size ('10pt', '11pt' or '12pt'). + # + # 'pointsize': '10pt', + + # Additional stuff for the LaTeX preamble. + # + # 'preamble': '', + + # Latex figure (float) alignment + # + # 'figure_align': 'htbp', +} + +# Grouping the document tree into LaTeX files. List of tuples +# (source start file, target name, title, +# author, documentclass [howto, manual, or own class]). +latex_documents = [ + (master_doc, 'Graphene.tex', u'Graphene Documentation', + u'Syrus Akbary', 'manual'), +] + +# The name of an image file (relative to this directory) to place at the top of +# the title page. +# +# latex_logo = None + +# For "manual" documents, if this is true, then toplevel headings are parts, +# not chapters. +# +# latex_use_parts = False + +# If true, show page references after internal links. +# +# latex_show_pagerefs = False + +# If true, show URL addresses after external links. +# +# latex_show_urls = False + +# Documents to append as an appendix to all manuals. +# +# latex_appendices = [] + +# It false, will not define \strong, \code, itleref, \crossref ... but only +# \sphinxstrong, ..., \sphinxtitleref, ... To help avoid clash with user added +# packages. +# +# latex_keep_old_macro_names = True + +# If false, no module index is generated. +# +# latex_domain_indices = True + + +# -- Options for manual page output --------------------------------------- + +# One entry per manual page. List of tuples +# (source start file, name, description, authors, manual section). +man_pages = [ + (master_doc, 'graphene_django', u'Graphene Django Documentation', + [author], 1) +] + +# If true, show URL addresses after external links. +# +# man_show_urls = False + + +# -- Options for Texinfo output ------------------------------------------- + +# Grouping the document tree into Texinfo files. List of tuples +# (source start file, target name, title, author, +# dir menu entry, description, category) +texinfo_documents = [ + (master_doc, 'Graphene-Django', u'Graphene Django Documentation', + author, 'Graphene Django', 'One line description of project.', + 'Miscellaneous'), +] + +# Documents to append as an appendix to all manuals. +# +# texinfo_appendices = [] + +# If false, no module index is generated. +# +# texinfo_domain_indices = True + +# How to display URL addresses: 'footnote', 'no', or 'inline'. +# +# texinfo_show_urls = 'footnote' + +# If true, do not generate a @detailmenu in the "Top" node's menu. +# +# texinfo_no_detailmenu = False + + +# -- Options for Epub output ---------------------------------------------- + +# Bibliographic Dublin Core info. +epub_title = project +epub_author = author +epub_publisher = author +epub_copyright = copyright + +# The basename for the epub file. It defaults to the project name. +# epub_basename = project + +# The HTML theme for the epub output. Since the default themes are not +# optimized for small screen space, using the same theme for HTML and epub +# output is usually not wise. This defaults to 'epub', a theme designed to save +# visual space. +# +# epub_theme = 'epub' + +# The language of the text. It defaults to the language option +# or 'en' if the language is not set. +# +# epub_language = '' + +# The scheme of the identifier. Typical schemes are ISBN or URL. +# epub_scheme = '' + +# The unique identifier of the text. This can be a ISBN number +# or the project homepage. +# +# epub_identifier = '' + +# A unique identification for the text. +# +# epub_uid = '' + +# A tuple containing the cover image and cover page html template filenames. +# +# epub_cover = () + +# A sequence of (type, uri, title) tuples for the guide element of content.opf. +# +# epub_guide = () + +# HTML files that should be inserted before the pages created by sphinx. +# The format is a list of tuples containing the path and title. +# +# epub_pre_files = [] + +# HTML files that should be inserted after the pages created by sphinx. +# The format is a list of tuples containing the path and title. +# +# epub_post_files = [] + +# A list of files that should not be packed into the epub file. +epub_exclude_files = ['search.html'] + +# The depth of the table of contents in toc.ncx. +# +# epub_tocdepth = 3 + +# Allow duplicate toc entries. +# +# epub_tocdup = True + +# Choose between 'default' and 'includehidden'. +# +# epub_tocscope = 'default' + +# Fix unsupported image types using the Pillow. +# +# epub_fix_images = False + +# Scale large images. +# +# epub_max_image_width = 0 + +# How to display URL addresses: 'footnote', 'no', or 'inline'. +# +# epub_show_urls = 'inline' + +# If false, no index is generated. +# +# epub_use_index = True + + +# Example configuration for intersphinx: refer to the Python standard library. +intersphinx_mapping = {'https://docs.python.org/': None} diff --git a/docs/debug.rst b/docs/debug.rst new file mode 100644 index 0000000..854edfe --- /dev/null +++ b/docs/debug.rst @@ -0,0 +1,68 @@ +Django Debug Middleware +======================= + +You can debug your GraphQL queries in a similar way to +`django-debug-toolbar `__, +but outputing in the results in GraphQL response as fields, instead of +the graphical HTML interface. + +For that, you will need to add the plugin in your graphene schema. + +Installation +------------ + +For use the Django Debug plugin in Graphene: + +* Add ``graphene_django.debug.DjangoDebugMiddleware`` into ``MIDDLEWARE`` in the ``GRAPHENE`` settings. + +* Add the ``debug`` field into the schema root ``Query`` with the value ``graphene.Field(DjangoDebug, name='__debug')``. + + +.. code:: python + + from graphene_django.debug import DjangoDebug + + class Query(graphene.ObjectType): + # ... + debug = graphene.Field(DjangoDebug, name='__debug') + + schema = graphene.Schema(query=Query) + + +And in your ``settings.py``: + +.. code:: python + + GRAPHENE = { + 'MIDDLEWARE': [ + 'graphene_django.debug.DjangoDebugMiddleware', + ] + } + +Querying +-------- + +You can query it for outputing all the sql transactions that happened in +the GraphQL request, like: + +.. code:: graphql + + { + # A example that will use the ORM for interact with the DB + allIngredients { + edges { + node { + id, + name + } + } + } + # Here is the debug field that will output the SQL queries + __debug { + sql { + rawSql + } + } + } + +Note that the ``__debug`` field must be the last field in your query. diff --git a/docs/filtering.rst b/docs/filtering.rst new file mode 100644 index 0000000..138fc14 --- /dev/null +++ b/docs/filtering.rst @@ -0,0 +1,165 @@ +Filtering +========= + +Graphene integrates with +`django-filter `__ to provide +filtering of results. See the `usage +documentation `__ +for details on the format for ``filter_fields``. + +This filtering is automatically available when implementing a ``relay.Node``. +Additionally ``django-filter`` is an optional dependency of Graphene. + +You will need to install it manually, which can be done as follows: + +.. code:: bash + + # You'll need to django-filter + pip install django-filter + +Note: The techniques below are demoed in the `cookbook example +app `__. + +Filterable fields +----------------- + +The ``filter_fields`` parameter is used to specify the fields which can +be filtered upon. The value specified here is passed directly to +``django-filter``, so see the `filtering +documentation `__ +for full details on the range of options available. + +For example: + +.. code:: python + + class AnimalNode(DjangoObjectType): + class Meta: + # Assume you have an Animal model defined with the following fields + model = Animal + filter_fields = ['name', 'genus', 'is_domesticated'] + interfaces = (relay.Node, ) + + class Query(ObjectType): + animal = relay.Node.Field(AnimalNode) + all_animals = DjangoFilterConnectionField(AnimalNode) + +You could then perform a query such as: + +.. code:: graphql + + query { + # Note that fields names become camelcased + allAnimals(genus: "cat", isDomesticated: true) { + edges { + node { + id, + name + } + } + } + } + +You can also make more complex lookup types available: + +.. code:: python + + class AnimalNode(DjangoObjectType): + class Meta: + model = Animal + # Provide more complex lookup types + filter_fields = { + 'name': ['exact', 'icontains', 'istartswith'], + 'genus': ['exact'], + 'is_domesticated': ['exact'], + } + interfaces = (relay.Node, ) + +Which you could query as follows: + +.. code:: graphql + + query { + # Note that fields names become camelcased + allAnimals(name_Icontains: "lion") { + edges { + node { + id, + name + } + } + } + } + +Orderable fields +---------------- + +Ordering can also be specified using ``filter_order_by``. Like +``filter_fields``, this value is also passed directly to +``django-filter`` as the ``order_by`` field. For full details see the +`order\_by +documentation `__. + +For example: + +.. code:: python + + class AnimalNode(DjangoObjectType): + class Meta: + model = Animal + filter_fields = ['name', 'genus', 'is_domesticated'] + # Either a tuple/list of fields upon which ordering is allowed, or + # True to allow filtering on all fields specified in filter_fields + order_by_fields = True + interfaces = (relay.Node, ) + +You can then control the ordering via the ``orderBy`` argument: + +.. code:: graphql + + query { + allAnimals(orderBy: "name") { + edges { + node { + id, + name + } + } + } + } + +Custom Filtersets +----------------- + +By default Graphene provides easy access to the most commonly used +features of ``django-filter``. This is done by transparently creating a +``django_filters.FilterSet`` class for you and passing in the values for +``filter_fields`` and ``order_by_fields``. + +However, you may find this to be insufficient. In these cases you can +create your own ``Filterset`` as follows: + +.. code:: python + + class AnimalNode(DjangoObjectType): + class Meta: + # Assume you have an Animal model defined with the following fields + model = Animal + filter_fields = ['name', 'genus', 'is_domesticated'] + interfaces = (relay.Node, ) + + + class AnimalFilter(django_filters.FilterSet): + # Do case-insensitive lookups on 'name' + name = django_filters.CharFilter(lookup_type='iexact') + + class Meta: + model = Animal + fields = ['name', 'genus', 'is_domesticated'] + + + class Query(ObjectType): + animal = relay.Node.Field(AnimalNode) + # We specify our custom AnimalFilter using the filterset_class param + all_animals = DjangoFilterConnectionField(AnimalNode, + filterset_class=AnimalFilter) diff --git a/docs/index.rst b/docs/index.rst new file mode 100644 index 0000000..c8b5515 --- /dev/null +++ b/docs/index.rst @@ -0,0 +1,13 @@ +Graphene-Django +=============== + +Contents: + +.. toctree:: + :maxdepth: 0 + + tutorial + filtering + authorization + debug + introspection diff --git a/docs/introspection.rst b/docs/introspection.rst new file mode 100644 index 0000000..7db21ca --- /dev/null +++ b/docs/introspection.rst @@ -0,0 +1,52 @@ +Introspection Schema +==================== + +Relay uses `Babel Relay +Plugin `__ +that requires you to provide your GraphQL schema data. + +Graphene comes with a management command for Django to dump your schema +data to ``schema.json`` that is compatible with babel-relay-plugin. + +Usage +----- + +Include ``graphene_django`` to ``INSTALLED_APPS`` in you project +settings: + +.. code:: python + + INSTALLED_APPS += ('graphene_django') + +Assuming your Graphene schema is at ``tutorial.quickstart.schema``, run +the command: + +.. code:: bash + + ./manage.py graphql_schema --schema tutorial.quickstart.schema --out schema.json + +It dumps your full introspection schema to ``schema.json`` inside your +project root directory. Point ``babel-relay-plugin`` to this file and +you're ready to use Relay with Graphene GraphQL implementation. + +Advanced Usage +-------------- + +To simplify the command to ``./manage.py graphql_schema``, you can +specify the parameters in your settings.py: + +.. code:: python + + GRAPHENE = { + 'SCHEMA': 'tutorial.quickstart.schema', + 'SCHEMA_OUTPUT': 'data/schema.json' # defaults to schema.json + } + + +Running ``./manage.py graphql_schema`` dumps your schema to +``/data/schema.json``. + +Help +---- + +Run ``./manage.py graphql_schema -h`` for command usage. diff --git a/docs/tutorial.rst b/docs/tutorial.rst new file mode 100644 index 0000000..c274a19 --- /dev/null +++ b/docs/tutorial.rst @@ -0,0 +1,325 @@ +Graphene-Django Tutorial +======================== + +Graphene has a number of additional features that are designed to make +working with Django *really simple*. + +Note: The code in this quickstart is pulled from the `cookbook example +app `__. + +Setup the Django project +------------------------ + +We will setup the project, create the following: + +- A Django project called ``cookbook`` +- An app within ``cookbook`` called ``ingredients`` + +.. code:: bash + + # Create the project directory + mkdir cookbook + cd cookbook + + # Create a virtualenv to isolate our package dependencies locally + virtualenv env + source env/bin/activate # On Windows use `env\Scripts\activate` + + # Install Django and Graphene with Django support + pip install django + pip install graphene_django + + # Set up a new project with a single application + django-admin.py startproject cookbook . # Note the trailing '.' character + django-admin.py startapp ingredients + +Now sync your database for the first time: + +.. code:: bash + + python manage.py migrate + +Let's create a few simple models... + +Defining our models +------------------- + +Let's get started with these models: + +.. code:: python + + # cookbook/ingredients/models.py + from django.db import models + + + class Category(models.Model): + name = models.CharField(max_length=100) + + def __str__(self): + return self.name + + + class Ingredient(models.Model): + name = models.CharField(max_length=100) + notes = models.TextField() + category = models.ForeignKey(Category, related_name='ingredients') + + def __str__(self): + return self.name + +Schema +------ + +GraphQL presents your objects to the world as a graph structure rather +than a more hierarchical structure to which you may be accustomed. In +order to create this representation, Graphene needs to know about each +*type* of object which will appear in the graph. + +This graph also has a *root type* through which all access begins. This +is the ``Query`` class below. In this example, we provide the ability to +list all ingredients via ``all_ingredients``, and the ability to obtain +a specific ingredient via ``ingredient``. + +Create ``cookbook/ingredients/schema.py`` and type the following: + +.. code:: python + + # cookbook/ingredients/schema.py + from graphene import relay, ObjectType, AbstractType + from graphene_django import DjangoObjectType + from graphene_django.filter import DjangoFilterConnectionField + + from cookbook.ingredients.models import Category, Ingredient + + + # Graphene will automatically map the Category model's fields onto the CategoryNode. + # This is configured in the CategoryNode's Meta class (as you can see below) + class CategoryNode(DjangoObjectType): + class Meta: + model = Category + filter_fields = ['name', 'ingredients'] + filter_order_by = ['name'] + interfaces = (relay.Node, ) + + + class IngredientNode(DjangoObjectType): + class Meta: + model = Ingredient + # Allow for some more advanced filtering here + filter_fields = { + 'name': ['exact', 'icontains', 'istartswith'], + 'notes': ['exact', 'icontains'], + 'category': ['exact'], + 'category__name': ['exact'], + } + filter_order_by = ['name', 'category__name'] + interfaces = (relay.Node, ) + + + class Query(AbstractType): + category = relay.Node.Field(CategoryNode) + all_categories = DjangoFilterConnectionField(CategoryNode) + + ingredient = relay.Node.Field(IngredientNode) + all_ingredients = DjangoFilterConnectionField(IngredientNode) + + +The filtering functionality is provided by +`django-filter `__. See the +`usage +documentation `__ +for details on the format for ``filter_fields``. While optional, this +tutorial makes use of this functionality so you will need to install +``django-filter`` for this tutorial to work: + +.. code:: bash + + pip install django-filter + +Note that the above ``Query`` class is marked as 'abstract'. This is +because we will now create a project-level query which will combine all +our app-level queries. + +Create the parent project-level ``cookbook/schema.py``: + +.. code:: python + + import graphene + + import cookbook.ingredients.schema + + + class Query(cookbook.ingredients.schema.Query): + # This class will inherit from multiple Queries + # as we begin to add more apps to our project + pass + + schema = graphene.Schema(query=Query) + +You can think of this as being something like your top-level ``urls.py`` +file (although it currently lacks any namespacing). + +Update settings +--------------- + +Next, install your app and GraphiQL in your Django project. GraphiQL is +a web-based integrated development environment to assist in the writing +and executing of GraphQL queries. It will provide us with a simple and +easy way of testing our cookbook project. + +Add ``ingredients`` and ``graphene_django`` to ``INSTALLED_APPS`` in ``cookbook/settings.py``: + +.. code:: python + + INSTALLED_APPS = [ + ... + # This will also make the `graphql_schema` management command available + 'graphene_django', + + # Install the ingredients app + 'ingredients', + ] + +And then add the ``SCHEMA`` to the ``GRAPHENE`` config in ``cookbook/settings.py``: + +.. code:: python + + GRAPHENE = { + 'SCHEMA': 'cookbook.schema.schema' + } + + +Creating GraphQL and GraphiQL views +----------------------------------- + +Unlike a RESTful API, there is only a single URL from which GraphQL is +accessed. Requests to this URL are handled by Graphene's ``GraphQLView`` +view. + +This view will serve as GraphQL endpoint. As we want to have the +aforementioned GraphiQL we specify that on the params with ``graphiql=True``. + +.. code:: python + + from django.conf.urls import url, include + from django.contrib import admin + + from graphene_django.views import GraphQLView + + from cookbook.schema import schema + + urlpatterns = [ + url(r'^admin/', admin.site.urls), + url(r'^graphql', GraphQLView.as_view(graphiql=True)), + ] + +Apply model changes to database +------------------------------- + +Tell Django that we've added models and update the database schema to +reflect these additions. + +.. code:: bash + + python manage.py makemigrations + python manage.py migrate + +Load some test data +------------------- + +Now is a good time to load up some test data. The easiest option will be +to `download the +ingredients.json `__ +fixture and place it in +``cookbook/ingredients/fixtures/ingredients.json``. You can then run the +following: + +.. code:: bash + + $ python ./manage.py loaddata ingredients + + Installed 6 object(s) from 1 fixture(s) + +Alternatively you can use the Django admin interface to create some data +yourself. You'll need to run the development server (see below), and +create a login for yourself too (``./manage.py createsuperuser``). + +Testing our GraphQL schema +-------------------------- + +We're now ready to test the API we've built. Let's fire up the server +from the command line. + +.. code:: bash + + $ python ./manage.py runserver + + Performing system checks... + Django version 1.9, using settings 'cookbook.settings' + Starting development server at http://127.0.0.1:8000/ + Quit the server with CONTROL-C. + +Go to `localhost:8000/graphiql `__ and +type your first query! + +.. code:: graphql + + query { + allIngredients { + edges { + node { + id, + name + } + } + } + } + +The above will return the names & IDs for all ingredients. But perhaps +you want a specific ingredient: + +.. code:: graphql + + query { + # Graphene creates globally unique IDs for all objects. + # You may need to copy this value from the results of the first query + ingredient(id: "SW5ncmVkaWVudE5vZGU6MQ==") { + name + } + } + +You can also get each ingredient for each category: + +.. code:: graphql + + query { + allCategories { + edges { + node { + name, + ingredients { + edges { + node { + name + } + } + } + } + } + } + } + +Or you can get only 'meat' ingredients containing the letter 'e': + +.. code:: graphql + + query { + # You can also use `category: "CATEGORY GLOBAL ID"` + allIngredients(name_Icontains: "e", category_Name: "Meat") { + edges { + node { + name + } + } + } + }