From 80238bc78513968c666dbf9dc6cf0ae44c202d11 Mon Sep 17 00:00:00 2001 From: Tyson Clugg Date: Tue, 13 Oct 2015 23:13:41 +1100 Subject: [PATCH 1/8] Make the SQL for subscriptions much faster to run. The PostgreSQL query planner knows to short-circuit some operators such as IN or ANY such that `foo_id IN (SELECT foo.id FROM foo WHERE ...)` doesn't need to perform a full table scan on foo. This change ensures that `user_rel` WHERE clauses use the `IN` operator to take advantage of the greatly improved performance. --- dddp/api.py | 19 ++++++++++++++++++- 1 file changed, 18 insertions(+), 1 deletion(-) diff --git a/dddp/api.py b/dddp/api.py index e23ccc4..fe347da 100644 --- a/dddp/api.py +++ b/dddp/api.py @@ -279,8 +279,25 @@ class Collection(APIMixin): if isinstance(user_rels, basestring): user_rels = [user_rels] user_filter = None + # Django supports model._meta -> pylint: disable=W0212 + meta = self.model._meta for user_rel in user_rels: - filter_obj = Q(**{user_rel: user}) + name, rel = (user_rel.split('__', 1) + [None])[:2] + field = meta.pk if name == 'pk' else meta.get_field(name) + # generate `filter_obj` (instance of django.db.models.Q) + if field not in meta.local_fields: + # user_rel spans a join - ensure efficient SQL is generated + # such as `...WHERE foo_id IN (SELECT foo.id FROM ...)` + # rather than creating an explosion of INNER JOINS. + filter_obj = Q(**{ + '%s__in' % name: field.related_model.objects.filter( + **{rel or 'pk': user} + ).values('pk'), + }) + else: + # user rel is a local field -> no joins to avoid. + filter_obj = Q(**{str(user_rel): user}) + # merge `filter_obj` into `user_filter` if user_filter is None: user_filter = filter_obj else: From 27c270f40fa536daa928b4af3f953e2f52c433cc Mon Sep 17 00:00:00 2001 From: Tyson Clugg Date: Tue, 13 Oct 2015 23:44:15 +1100 Subject: [PATCH 2/8] Fixes #6 (again) -- Python 3 style exception handling. --- dddp/api.py | 2 +- dddp/websocket.py | 12 ++++++------ 2 files changed, 7 insertions(+), 7 deletions(-) diff --git a/dddp/api.py b/dddp/api.py index fe347da..b60a066 100644 --- a/dddp/api.py +++ b/dddp/api.py @@ -762,7 +762,7 @@ class DDP(APIMixin): if result is not None: msg['result'] = result this.send(msg) - except Exception, err: # log error+stack trace -> pylint: disable=W0703 + except Exception as err: # log err+stack trace -> pylint: disable=W0703 details = traceback.format_exc() print(id_, method, params_repr) print(details) diff --git a/dddp/websocket.py b/dddp/websocket.py index 3da9efd..6d098c5 100644 --- a/dddp/websocket.py +++ b/dddp/websocket.py @@ -163,7 +163,7 @@ class DDPWebSocketApplication(geventwebsocket.WebSocketApplication): # parse message set try: msgs = ejson.loads(message) - except ValueError, err: + except ValueError as err: self.error(400, 'Data is not valid EJSON') return if not isinstance(msgs, list): @@ -176,7 +176,7 @@ class DDPWebSocketApplication(geventwebsocket.WebSocketApplication): raw = msgs.pop(0) try: data = ejson.loads(raw) - except (TypeError, ValueError), err: + except (TypeError, ValueError) as err: self.error(400, 'Data is not valid EJSON') continue if not isinstance(data, dict): @@ -190,12 +190,12 @@ class DDPWebSocketApplication(geventwebsocket.WebSocketApplication): # dispatch message try: self.dispatch(msg, data) - except MeteorError, err: + except MeteorError as err: self.error(err) - except Exception, err: + except Exception as err: traceback.print_exc() self.error(err) - except geventwebsocket.WebSocketError, err: + except geventwebsocket.WebSocketError as err: self.ws.close() @transaction.atomic @@ -220,7 +220,7 @@ class DDPWebSocketApplication(geventwebsocket.WebSocketApplication): # dispatch to handler try: handler(**kwargs) - except Exception, err: # print stack trace --> pylint: disable=W0703 + except Exception as err: # print stack trace --> pylint: disable=W0703 traceback.print_exc() self.error(500, 'Internal server error', err) From fe6b214f9001b6ad16a5840cf794f23704334ad0 Mon Sep 17 00:00:00 2001 From: Tyson Clugg Date: Wed, 14 Oct 2015 00:19:45 +1100 Subject: [PATCH 3/8] Trimmed fat from .gitignore --- .gitignore | 74 +++++++++++++----------------------------------------- 1 file changed, 17 insertions(+), 57 deletions(-) diff --git a/.gitignore b/.gitignore index 0006a0a..f2ee739 100644 --- a/.gitignore +++ b/.gitignore @@ -1,60 +1,20 @@ -# Byte-compiled / optimized / DLL files -__pycache__/ -*.py[cod] +# If you need to exclude files such as those generated by an IDE, use +# $GIT_DIR/info/exclude or the core.excludesFile configuration variable as +# described in https://git-scm.com/docs/gitignore -# C extensions -*.so - -# Distribution / packaging -.Python -env/ -build/ -develop-eggs/ -dist/ -downloads/ -eggs/ -lib/ -lib64/ -parts/ -sdist/ -var/ -*.egg-info/ -.installed.cfg -*.egg - -# PyInstaller -# Usually these files are written by a python script from a template -# before PyInstaller builds the exe, so as to inject date/other infos into it. -*.manifest -*.spec - -# Installer logs -pip-log.txt -pip-delete-this-directory.txt - -# Unit test / coverage reports -htmlcov/ -.tox/ -.coverage -.cache -nosetests.xml -coverage.xml - -# Translations -*.mo +*.egg-info *.pot - -# Django stuff: -*.log - -# Sphinx documentation +*.py[co] +__pycache__ +MANIFEST +dist/ docs/_build/ - -# PyBuilder -target/ - -# Rope -.ropeproject/ - -# Editor cruft -*.swp +docs/locale/ +node_modules/ +tests/coverage_html/ +tests/.coverage +build/ +tests/report/ +.coverage +.eggs/ +.tox/ From 1e767ce521651ee97770733be34ff1615adb6da4 Mon Sep 17 00:00:00 2001 From: Tyson Clugg Date: Wed, 14 Oct 2015 00:21:30 +1100 Subject: [PATCH 4/8] Fixes #10 -- Started documentation --- README.rst | 6 +- docs/Makefile | 177 ++++++++++++++++++++++++++++++ docs/changelog.rst | 3 + docs/conf.py | 263 +++++++++++++++++++++++++++++++++++++++++++++ docs/index.rst | 51 +++++++++ docs/make.bat | 242 +++++++++++++++++++++++++++++++++++++++++ 6 files changed, 741 insertions(+), 1 deletion(-) create mode 100644 docs/Makefile create mode 100644 docs/changelog.rst create mode 100644 docs/conf.py create mode 100644 docs/index.rst create mode 100644 docs/make.bat diff --git a/README.rst b/README.rst index dc17f00..b6911ea 100644 --- a/README.rst +++ b/README.rst @@ -1,4 +1,4 @@ -django-ddp +Django DDP ========== Django_/PostgreSQL_ implementation of the Meteor DDP service, allowing Meteor_ to subscribe to changes on Django_ models. Released under the MIT license. @@ -232,8 +232,12 @@ Contributors `Muhammed Thanish `_ * Making the `DDP Test Suite `_ available. +This project is forever grateful for the love, support and respect given +by the awesome team at `Common Code`_. + .. _Django: https://www.djangoproject.com/ .. _Django signals: https://docs.djangoproject.com/en/stable/topics/signals/ +.. _Common Code: https://commoncode.com.au/ .. _PostgreSQL: http://postgresql.org/ .. _psycopg2: http://initd.org/psycopg/ .. _WebSockets: http://www.w3.org/TR/websockets/ diff --git a/docs/Makefile b/docs/Makefile new file mode 100644 index 0000000..1912130 --- /dev/null +++ b/docs/Makefile @@ -0,0 +1,177 @@ +# Makefile for Sphinx documentation +# + +# You can set these variables from the command line. +SPHINXOPTS = +SPHINXBUILD = sphinx-build +PAPER = +BUILDDIR = _build + +# User-friendly check for sphinx-build +ifeq ($(shell which $(SPHINXBUILD) >/dev/null 2>&1; echo $$?), 1) +$(error The '$(SPHINXBUILD)' command was not found. Make sure you have Sphinx installed, then set the SPHINXBUILD environment variable to point to the full path of the '$(SPHINXBUILD)' executable. Alternatively you can add the directory with the executable to your PATH. If you don't have Sphinx installed, grab it from http://sphinx-doc.org/) +endif + +# 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 clean html dirhtml singlehtml pickle json htmlhelp qthelp devhelp epub latex latexpdf text man changes linkcheck doctest gettext + +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 " devhelp to make HTML files and a Devhelp project" + @echo " epub to make an epub" + @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)" + +clean: + rm -rf $(BUILDDIR)/* + +html: + $(SPHINXBUILD) -b html $(ALLSPHINXOPTS) $(BUILDDIR)/html + @echo + @echo "Build finished. The HTML pages are in $(BUILDDIR)/html." + +dirhtml: + $(SPHINXBUILD) -b dirhtml $(ALLSPHINXOPTS) $(BUILDDIR)/dirhtml + @echo + @echo "Build finished. The HTML pages are in $(BUILDDIR)/dirhtml." + +singlehtml: + $(SPHINXBUILD) -b singlehtml $(ALLSPHINXOPTS) $(BUILDDIR)/singlehtml + @echo + @echo "Build finished. The HTML page is in $(BUILDDIR)/singlehtml." + +pickle: + $(SPHINXBUILD) -b pickle $(ALLSPHINXOPTS) $(BUILDDIR)/pickle + @echo + @echo "Build finished; now you can process the pickle files." + +json: + $(SPHINXBUILD) -b json $(ALLSPHINXOPTS) $(BUILDDIR)/json + @echo + @echo "Build finished; now you can process the JSON files." + +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." + +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/DjangoDDP.qhcp" + @echo "To view the help file:" + @echo "# assistant -collectionFile $(BUILDDIR)/qthelp/DjangoDDP.qhc" + +devhelp: + $(SPHINXBUILD) -b devhelp $(ALLSPHINXOPTS) $(BUILDDIR)/devhelp + @echo + @echo "Build finished." + @echo "To view the help file:" + @echo "# mkdir -p $$HOME/.local/share/devhelp/DjangoDDP" + @echo "# ln -s $(BUILDDIR)/devhelp $$HOME/.local/share/devhelp/DjangoDDP" + @echo "# devhelp" + +epub: + $(SPHINXBUILD) -b epub $(ALLSPHINXOPTS) $(BUILDDIR)/epub + @echo + @echo "Build finished. The epub file is in $(BUILDDIR)/epub." + +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)." + +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." + +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." + +text: + $(SPHINXBUILD) -b text $(ALLSPHINXOPTS) $(BUILDDIR)/text + @echo + @echo "Build finished. The text files are in $(BUILDDIR)/text." + +man: + $(SPHINXBUILD) -b man $(ALLSPHINXOPTS) $(BUILDDIR)/man + @echo + @echo "Build finished. The manual pages are in $(BUILDDIR)/man." + +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)." + +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." + +gettext: + $(SPHINXBUILD) -b gettext $(I18NSPHINXOPTS) $(BUILDDIR)/locale + @echo + @echo "Build finished. The message catalogs are in $(BUILDDIR)/locale." + +changes: + $(SPHINXBUILD) -b changes $(ALLSPHINXOPTS) $(BUILDDIR)/changes + @echo + @echo "The overview file is in $(BUILDDIR)/changes." + +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." + +doctest: + $(SPHINXBUILD) -b doctest $(ALLSPHINXOPTS) $(BUILDDIR)/doctest + @echo "Testing of doctests in the sources finished, look at the " \ + "results in $(BUILDDIR)/doctest/output.txt." + +xml: + $(SPHINXBUILD) -b xml $(ALLSPHINXOPTS) $(BUILDDIR)/xml + @echo + @echo "Build finished. The XML files are in $(BUILDDIR)/xml." + +pseudoxml: + $(SPHINXBUILD) -b pseudoxml $(ALLSPHINXOPTS) $(BUILDDIR)/pseudoxml + @echo + @echo "Build finished. The pseudo-XML files are in $(BUILDDIR)/pseudoxml." diff --git a/docs/changelog.rst b/docs/changelog.rst new file mode 100644 index 0000000..f6a3529 --- /dev/null +++ b/docs/changelog.rst @@ -0,0 +1,3 @@ +.. _changelog: + +.. include:: ../CHANGES.rst diff --git a/docs/conf.py b/docs/conf.py new file mode 100644 index 0000000..4c58a44 --- /dev/null +++ b/docs/conf.py @@ -0,0 +1,263 @@ +# -*- coding: utf-8 -*- +# +# Django DDP documentation build configuration file, created by +# sphinx-quickstart on Tue Oct 13 23:24:39 2015. +# +# 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. + +import sys +import os + +# 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. +#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.todo', + 'sphinx.ext.coverage', + 'sphinx.ext.viewcode', +] + +# Add any paths that contain templates here, relative to this directory. +templates_path = ['_templates'] + +# The suffix of source filenames. +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'Django DDP' +copyright = u'2015, Tyson Clugg' + +# 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 = '0.16' +# The full version, including alpha/beta/rc tags. +release = '0.16.0' + +# The language for content autogenerated by Sphinx. Refer to documentation +# for a list of supported languages. +#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. +exclude_patterns = ['_build'] + +# 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 + + +# -- 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 = 'default' + +# 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. If None, it defaults to +# " v documentation". +#html_title = None + +# 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 (within the static path) to use as 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 '', a 'Last updated on:' timestamp is inserted at every page bottom, +# using the given strftime format. +#html_last_updated_fmt = '%b %d, %Y' + +# 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 + +# Output file base name for HTML help builder. +htmlhelp_basename = 'DjangoDDPdoc' + + +# -- 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': '', +} + +# 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 = [ + ('index', 'DjangoDDP.tex', u'Django DDP Documentation', + u'Tyson Clugg', '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 = [] + +# 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 = [ + ('index', 'djangoddp', u'Django DDP Documentation', + [u'Tyson Clugg'], 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 = [ + ('index', 'DjangoDDP', u'Django DDP Documentation', + u'Tyson Clugg', 'DjangoDDP', '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 diff --git a/docs/index.rst b/docs/index.rst new file mode 100644 index 0000000..001c5eb --- /dev/null +++ b/docs/index.rst @@ -0,0 +1,51 @@ +.. Django DDP documentation master file, created by + sphinx-quickstart on Tue Oct 13 23:24:39 2015. + You can adapt this file completely to your liking, but it should at least + contain the root `toctree` directive. + +.. include:: ../README.rst + +Installation: +------------- +`Django DDP`_ is available for installation direct from PyPi_: + +.. code:: bash + + pip install django-ddp + +Links +----- + +.. image:: https://readthedocs.org/projects/django-ddp/badge/?version=latest + :target: https://readthedocs.org/projects/django-ddp/?badge=latest + :alt: Documentation Status + :align: right + +The latest documentation is available online at +https://django-ddp.readthedocs.org/. + +Source code is available online at https://github.com/commoncode/django-ddp. + +Contents +-------- + +.. toctree:: + :glob: + :maxdepth: 1 + + changelog + django-ddp* + + +Indices and tables +================== + +* :ref:`genindex` +* :ref:`modindex` +* :ref:`search` + +License +======= +.. include:: ../LICENSE + +.. _pypi: https://pypi.python.org/pypi/django-ddp diff --git a/docs/make.bat b/docs/make.bat new file mode 100644 index 0000000..5e9ef87 --- /dev/null +++ b/docs/make.bat @@ -0,0 +1,242 @@ +@ECHO OFF + +REM Command file for Sphinx documentation + +if "%SPHINXBUILD%" == "" ( + set SPHINXBUILD=sphinx-build +) +set BUILDDIR=_build +set ALLSPHINXOPTS=-d %BUILDDIR%/doctrees %SPHINXOPTS% . +set I18NSPHINXOPTS=%SPHINXOPTS% . +if NOT "%PAPER%" == "" ( + set ALLSPHINXOPTS=-D latex_paper_size=%PAPER% %ALLSPHINXOPTS% + set I18NSPHINXOPTS=-D latex_paper_size=%PAPER% %I18NSPHINXOPTS% +) + +if "%1" == "" goto help + +if "%1" == "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. devhelp to make HTML files and a Devhelp project + echo. epub to make an epub + echo. latex to make LaTeX files, you can set PAPER=a4 or PAPER=letter + echo. text to make text files + echo. man to make manual pages + echo. texinfo to make Texinfo files + echo. gettext to make PO message catalogs + echo. changes to make an overview over 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 + goto end +) + +if "%1" == "clean" ( + for /d %%i in (%BUILDDIR%\*) do rmdir /q /s %%i + del /q /s %BUILDDIR%\* + goto end +) + + +%SPHINXBUILD% 2> nul +if errorlevel 9009 ( + echo. + echo.The 'sphinx-build' command was not found. Make sure you have Sphinx + echo.installed, then set the SPHINXBUILD environment variable to point + echo.to the full path of the 'sphinx-build' executable. Alternatively you + echo.may add the Sphinx directory to PATH. + echo. + echo.If you don't have Sphinx installed, grab it from + echo.http://sphinx-doc.org/ + exit /b 1 +) + +if "%1" == "html" ( + %SPHINXBUILD% -b html %ALLSPHINXOPTS% %BUILDDIR%/html + if errorlevel 1 exit /b 1 + echo. + echo.Build finished. The HTML pages are in %BUILDDIR%/html. + goto end +) + +if "%1" == "dirhtml" ( + %SPHINXBUILD% -b dirhtml %ALLSPHINXOPTS% %BUILDDIR%/dirhtml + if errorlevel 1 exit /b 1 + echo. + echo.Build finished. The HTML pages are in %BUILDDIR%/dirhtml. + goto end +) + +if "%1" == "singlehtml" ( + %SPHINXBUILD% -b singlehtml %ALLSPHINXOPTS% %BUILDDIR%/singlehtml + if errorlevel 1 exit /b 1 + echo. + echo.Build finished. The HTML pages are in %BUILDDIR%/singlehtml. + goto end +) + +if "%1" == "pickle" ( + %SPHINXBUILD% -b pickle %ALLSPHINXOPTS% %BUILDDIR%/pickle + if errorlevel 1 exit /b 1 + echo. + echo.Build finished; now you can process the pickle files. + goto end +) + +if "%1" == "json" ( + %SPHINXBUILD% -b json %ALLSPHINXOPTS% %BUILDDIR%/json + if errorlevel 1 exit /b 1 + echo. + echo.Build finished; now you can process the JSON files. + goto end +) + +if "%1" == "htmlhelp" ( + %SPHINXBUILD% -b htmlhelp %ALLSPHINXOPTS% %BUILDDIR%/htmlhelp + if errorlevel 1 exit /b 1 + echo. + echo.Build finished; now you can run HTML Help Workshop with the ^ +.hhp project file in %BUILDDIR%/htmlhelp. + goto end +) + +if "%1" == "qthelp" ( + %SPHINXBUILD% -b qthelp %ALLSPHINXOPTS% %BUILDDIR%/qthelp + if errorlevel 1 exit /b 1 + echo. + echo.Build finished; now you can run "qcollectiongenerator" with the ^ +.qhcp project file in %BUILDDIR%/qthelp, like this: + echo.^> qcollectiongenerator %BUILDDIR%\qthelp\DjangoDDP.qhcp + echo.To view the help file: + echo.^> assistant -collectionFile %BUILDDIR%\qthelp\DjangoDDP.ghc + goto end +) + +if "%1" == "devhelp" ( + %SPHINXBUILD% -b devhelp %ALLSPHINXOPTS% %BUILDDIR%/devhelp + if errorlevel 1 exit /b 1 + echo. + echo.Build finished. + goto end +) + +if "%1" == "epub" ( + %SPHINXBUILD% -b epub %ALLSPHINXOPTS% %BUILDDIR%/epub + if errorlevel 1 exit /b 1 + echo. + echo.Build finished. The epub file is in %BUILDDIR%/epub. + goto end +) + +if "%1" == "latex" ( + %SPHINXBUILD% -b latex %ALLSPHINXOPTS% %BUILDDIR%/latex + if errorlevel 1 exit /b 1 + echo. + echo.Build finished; the LaTeX files are in %BUILDDIR%/latex. + goto end +) + +if "%1" == "latexpdf" ( + %SPHINXBUILD% -b latex %ALLSPHINXOPTS% %BUILDDIR%/latex + cd %BUILDDIR%/latex + make all-pdf + cd %BUILDDIR%/.. + echo. + echo.Build finished; the PDF files are in %BUILDDIR%/latex. + goto end +) + +if "%1" == "latexpdfja" ( + %SPHINXBUILD% -b latex %ALLSPHINXOPTS% %BUILDDIR%/latex + cd %BUILDDIR%/latex + make all-pdf-ja + cd %BUILDDIR%/.. + echo. + echo.Build finished; the PDF files are in %BUILDDIR%/latex. + goto end +) + +if "%1" == "text" ( + %SPHINXBUILD% -b text %ALLSPHINXOPTS% %BUILDDIR%/text + if errorlevel 1 exit /b 1 + echo. + echo.Build finished. The text files are in %BUILDDIR%/text. + goto end +) + +if "%1" == "man" ( + %SPHINXBUILD% -b man %ALLSPHINXOPTS% %BUILDDIR%/man + if errorlevel 1 exit /b 1 + echo. + echo.Build finished. The manual pages are in %BUILDDIR%/man. + goto end +) + +if "%1" == "texinfo" ( + %SPHINXBUILD% -b texinfo %ALLSPHINXOPTS% %BUILDDIR%/texinfo + if errorlevel 1 exit /b 1 + echo. + echo.Build finished. The Texinfo files are in %BUILDDIR%/texinfo. + goto end +) + +if "%1" == "gettext" ( + %SPHINXBUILD% -b gettext %I18NSPHINXOPTS% %BUILDDIR%/locale + if errorlevel 1 exit /b 1 + echo. + echo.Build finished. The message catalogs are in %BUILDDIR%/locale. + goto end +) + +if "%1" == "changes" ( + %SPHINXBUILD% -b changes %ALLSPHINXOPTS% %BUILDDIR%/changes + if errorlevel 1 exit /b 1 + echo. + echo.The overview file is in %BUILDDIR%/changes. + goto end +) + +if "%1" == "linkcheck" ( + %SPHINXBUILD% -b linkcheck %ALLSPHINXOPTS% %BUILDDIR%/linkcheck + if errorlevel 1 exit /b 1 + echo. + echo.Link check complete; look for any errors in the above output ^ +or in %BUILDDIR%/linkcheck/output.txt. + goto end +) + +if "%1" == "doctest" ( + %SPHINXBUILD% -b doctest %ALLSPHINXOPTS% %BUILDDIR%/doctest + if errorlevel 1 exit /b 1 + echo. + echo.Testing of doctests in the sources finished, look at the ^ +results in %BUILDDIR%/doctest/output.txt. + goto end +) + +if "%1" == "xml" ( + %SPHINXBUILD% -b xml %ALLSPHINXOPTS% %BUILDDIR%/xml + if errorlevel 1 exit /b 1 + echo. + echo.Build finished. The XML files are in %BUILDDIR%/xml. + goto end +) + +if "%1" == "pseudoxml" ( + %SPHINXBUILD% -b pseudoxml %ALLSPHINXOPTS% %BUILDDIR%/pseudoxml + if errorlevel 1 exit /b 1 + echo. + echo.Build finished. The pseudo-XML files are in %BUILDDIR%/pseudoxml. + goto end +) + +:end From d1b91891cd9bcc555fa4f1a6c57a667d3c831e55 Mon Sep 17 00:00:00 2001 From: Tyson Clugg Date: Wed, 14 Oct 2015 00:26:48 +1100 Subject: [PATCH 5/8] Add concrete requirement files for test suite (#11). --- requirements.txt | 4 ++++ test-requirements.txt | 1 + 2 files changed, 5 insertions(+) create mode 100644 requirements.txt create mode 100644 test-requirements.txt diff --git a/requirements.txt b/requirements.txt new file mode 100644 index 0000000..08a16e3 --- /dev/null +++ b/requirements.txt @@ -0,0 +1,4 @@ +Django==1.8.5 +gevent==1.0.2 +gevent-websocket==0.9.5 +psycopg2==2.6.1 diff --git a/test-requirements.txt b/test-requirements.txt new file mode 100644 index 0000000..bc04b49 --- /dev/null +++ b/test-requirements.txt @@ -0,0 +1 @@ +-r requirements.txt From e0ae6134d15186ce2922a344149e3d82d1f627a1 Mon Sep 17 00:00:00 2001 From: Tyson Clugg Date: Wed, 14 Oct 2015 00:28:06 +1100 Subject: [PATCH 6/8] Use tox test runner - no tests yet (#11). --- tox.ini | 42 ++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 42 insertions(+) create mode 100644 tox.ini diff --git a/tox.ini b/tox.ini new file mode 100644 index 0000000..5e6919b --- /dev/null +++ b/tox.ini @@ -0,0 +1,42 @@ +# Tox (http://tox.testrun.org/) is a tool for running tests +# in multiple virtualenvs. This configuration file will run the +# test suite on all supported python versions. To use it, "pip install tox" +# and then run "tox" from this directory. + +[tox] +# require tox>=2.1.1 or refuse to run the tests. +minversion=2.1.1 + +# return success even if some of the specified environments are missing +skip_missing_interpreters=True + +# "envlist" is a comma separated list of environments, each environment name +# contains factors separated by hyphens. For example, "py27-unittest" has 2 +# factors: "py27" and "unittest". Other settings such as "setenv" accept the +# factor names as a prefixes (eg: "unittest: ...") so that prefixed settings +# only apply if the environment being run contains that factor. + +envlist = + py27-test, + py33-test, + py34-test, + py35-test, + +[testenv] +recreate=True +usedevelop=False +passenv= + BUILD_NUMBER + BUILD_URL + XDG_CACHE_HOME + +# continue running commands even if previous commands have failed +ignore_errors = True + +commands = + coverage run --source={toxinidir}/dddp {toxinidir}/setup.py test + coverage report + +deps = + -r{toxinidir}/test-requirements.txt + coverage From 472d0c10a48d5882831a2a11a59a528c75c02355 Mon Sep 17 00:00:00 2001 From: Tyson Clugg Date: Wed, 14 Oct 2015 00:28:39 +1100 Subject: [PATCH 7/8] Repeatable builds using ye olde make. --- MANIFEST.in | 9 +++++++++ Makefile | 42 ++++++++++++++++++++++++++++++++++++++++++ 2 files changed, 51 insertions(+) create mode 100644 MANIFEST.in create mode 100644 Makefile diff --git a/MANIFEST.in b/MANIFEST.in new file mode 100644 index 0000000..c8695af --- /dev/null +++ b/MANIFEST.in @@ -0,0 +1,9 @@ +include LICENSE +include *.rst +include *.sh +include *.txt +include Makefile +recursive-include docs *.bat +recursive-include docs *.py +recursive-include docs *.rst +recursive-include docs Makefile diff --git a/Makefile b/Makefile new file mode 100644 index 0000000..543eed0 --- /dev/null +++ b/Makefile @@ -0,0 +1,42 @@ +NAME := $(shell python setup.py --name) +VERSION := $(shell python setup.py --version) + +SDIST := dist/${NAME}-${VERSION}.tar.gz +WHEEL := dist/${NAME}-${VERSION}-py2.py3-none-any.whl + +.PHONY: all test clean clean-docs upload-docs upload-pypi dist docs + +all: docs dist + +test: + tox + +clean: clean-docs clean-sdist clean-wheel + +clean-docs: + $(MAKE) -C docs/ clean + +clean-sdist: + rm -f "${SDIST}" + +clean-wheel: + rm -f "${WHEEL}" + +docs: + $(MAKE) -C docs/ clean html + +${SDIST}: + python setup.py sdist + +${WHEEL}: + python setup.py bdist_wheel + +dist: test ${SDIST} ${WHEEL} + +upload: upload-pypi upload-docs + +upload-pypi: ${SDIST} ${WHEEL} + twine upload "${WHEEL}" "${SDIST}" + +upload-docs: docs/_build/ + python setup.py upload_sphinx --upload-dir="$ Date: Wed, 14 Oct 2015 01:05:46 +1100 Subject: [PATCH 8/8] Update CHANGES.rst, bump version number with updated script. --- CHANGES.rst | 9 +++++++++ bumpversion.sh | 10 +++++++++- docs/conf.py | 4 ++-- setup.py | 2 +- 4 files changed, 21 insertions(+), 4 deletions(-) diff --git a/CHANGES.rst b/CHANGES.rst index def0434..ab30310 100644 --- a/CHANGES.rst +++ b/CHANGES.rst @@ -1,6 +1,15 @@ Change Log ========== +0.17.0 +------ +* Make the SQL for subscriptions much faster for PostgreSQL. +* Repeatable builds using ye olde make. +* Use tox test runner - no tests yet (#11). +* Add concrete requirement files for test suite (#11). +* Started documentation using Sphinx (#10). +* Python 3 style exception handling. + 0.16.0 ------ * New setting: `DDP_API_ENDPOINT_DECORATORS`. diff --git a/bumpversion.sh b/bumpversion.sh index fa0e05a..9be02a3 100755 --- a/bumpversion.sh +++ b/bumpversion.sh @@ -1,3 +1,11 @@ #!/bin/sh +set -e cd "${0%/*}" -cat setup.py | sed -e "s/version='[0123456789]\{1,\}\.[0123456789]\{1,\}\.[01234567989]\{1,\}'/version='$( git rev-parse --abbrev-ref HEAD | cut -d / -f 2 )'/" > setup.py +OLD="$( python setup.py --version )" +NEW="$( git rev-parse --abbrev-ref HEAD | cut -d / -f 2 )" +echo "Bumping version ${OLD} -> ${NEW}...\n" +sed -e "s/^ version='${OLD}'/ version='${NEW}'/" setup.py > .setup.py +mv .setup.py setup.py +sed -e "s/^version = '${OLD%.*}'/version = '${NEW%.*}'/" -e "s/^release = '${OLD}/release = '${NEW}'/" docs/conf.py > docs/.conf.py +mv docs/.conf.py docs/conf.py +git diff setup.py docs/conf.py diff --git a/docs/conf.py b/docs/conf.py index 4c58a44..06482b0 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -56,9 +56,9 @@ copyright = u'2015, Tyson Clugg' # built documents. # # The short X.Y version. -version = '0.16' +version = '0.17' # The full version, including alpha/beta/rc tags. -release = '0.16.0' +release = '0.17.0'' # The language for content autogenerated by Sphinx. Refer to documentation # for a list of supported languages. diff --git a/setup.py b/setup.py index bb32f9b..050bd1f 100644 --- a/setup.py +++ b/setup.py @@ -44,7 +44,7 @@ CLASSIFIERS = [ setup( name='django-ddp', - version='0.16.0', + version='0.17.0', description=__doc__, long_description=open('README.rst').read(), author='Tyson Clugg',