Update master from main repo.

.github/workflows/publish.yml

@@ -0,0 +1,22 @@
+name: Publish to pypi
+on: [push]
+jobs:
+  Publish:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v2
+      - uses: actions/setup-python@v2
+        with:
+          python-version: 2.x
+      - name: Install dependencies
+        run: >-
+          python -m pip install --user --upgrade setuptools wheel
+      - name: Build
+        run: >-
+          python setup.py sdist bdist_wheel
+      - name: Publish package
+        if: github.event_name == 'push' && startsWith(github.ref, 'refs/tags')
+        uses: pypa/gh-action-pypi-publish@release/v1
+        with:
+          user: __token__
+          password: ${{ secrets.PYPI_API_TOKEN }}

.gitignore

@@ -1,2 +1,22 @@
 .coverage
 .noseids
+.build
+*.pyc
+
+\#*\#
+.idea
+gaepdb.py
+*.xml
+
+# for sphinx documentation
+doc/build/*
+doc/source/*
+!doc/source/conf.py
+!doc/source/index.txt
+!doc/source/design*.txt
+!doc/source/_static/*
+!doc/source/_templates/*
+
+bilobac
+dist/
+furious.egg-info/

.travis.yml

@@ -1,15 +1,27 @@
+sudo: false
 language: python
 python:
-  - "2.7"
+    - "2.7"
 
-# Setup the GAE SDK.
-before_script:
-  - wget http://googleappengine.googlecode.com/files/google_appengine_1.7.4.zip -nv
-  - unzip -q google_appengine_1.7.4.zip
+# Cache our Gcloud SDK between commands
+cache:
+  directories:
+  - "$HOME/google-cloud-sdk/"
 
-# command to install dependencies
-install: "pip install -r requirements.txt --use-mirrors"
+env:
+# Make sure gcloud command is on our PATH and the App Engine SDK is in the Python path
+- GAE_PYTHONPATH=${HOME}/.cache/google_appengine PATH=$PATH:${HOME}/google-cloud-sdk/bin PYTHONPATH=${PYTHONPATH}:${GAE_PYTHONPATH} CLOUDSDK_CORE_DISABLE_PROMPTS=1
 
-# command to run tests
-script: nosetests --gae-lib-path=./google_appengine
+before_install:
+# Install Google App Engine Python SDK
+- if [ ! -d "${GAE_PYTHONPATH}" ]; then
+    python scripts/fetch_gae_sdk.py $(dirname "${GAE_PYTHONPATH}");
+  fi
 
+install:
+- pip install -r requirements_dev.txt
+
+script:
+  - nosetests --gae-lib-path=./google_appengine --with-coverage
+  - python setup.py sdist
+  - pip install .

Makefile

@@ -0,0 +1,32 @@
+SHELL := /bin/bash
+PYTHON := python
+PIP := pip
+
+BUILD_DIR := .build
+
+clean:
+	find . -name "*.py[co]" -delete
+	rm -f .coverage
+
+distclean: clean
+	rm -rf $(BUILD_DIR)
+
+run: deps
+	dev_appserver.py .
+
+deps: py_dev_deps
+
+py_dev_deps: $(BUILD_DIR)/pip-dev.log
+
+$(BUILD_DIR)/pip-dev.log: requirements_dev.txt
+	@mkdir -p .build
+	$(PIP) install -Ur requirements_dev.txt | tee $(BUILD_DIR)/pip-dev.log
+
+unit: clean
+	nosetests
+
+integrations:
+	nosetests --logging-level=ERROR -a slow --with-coverage
+
+test: clean integrations
+

README.md

@@ -21,20 +21,34 @@ Usage
 
 In the simplest form, usage looks like:
 
-    from furious import Async
+    from furious.async import Async
 
     # Create an Async object.
     async = Async(
         target="your.module.func",
-        args=("positstional", "args"),
-        kwargs={"kwargs": "too"})
+        args=("positional", "args"),
+        kwargs={"foo": "bar"})
 
     # Tell the async to insert itself to be run.
     async.start()
 
 This inserts a task that will make the following call:
 
-    your.module.func("pos", "args", kwarg="too")
+    your.module.func("positional", "args", foo="bar")
+
+**CAUTION**: Arguments **must** be json-serializable. 
+Contrast that with the [deferred lib](https://cloud.google.com/appengine/articles/deferred), 
+which allows any picklable type 
+(see [What can be pickled and unpickled?](https://docs.python.org/2/library/pickle.html#what-can-be-pickled-and-unpickled)).
+
+Why did furious choose this limitation?
+When a python object that is pickled gets moved in the code base, 
+attempts to unpickle it will blow up. Furious tasks can run on 
+different instances at a future time by which there may have 
+been a code deploy done. References:
+
+* [Alex Gaynor: Pickles are for Delis, not Software - PyCon 2014 - YouTube](https://www.youtube.com/watch?v=7KnfGDajDQw&t=1292)
+* [Don't Pickle Your Data](http://www.benfrederickson.com/dont-pickle-your-data/)
 
 
 ### Grouping async jobs
@@ -56,7 +70,8 @@ You can group jobs together,
 
 It is possible to set options, like the target queue,
 
-    from furious import context, defaults
+    from furious import context
+    from furious.async import defaults
 
     @defaults(queue='square')
     def square_a_number(number):
@@ -89,7 +104,7 @@ Tasks targeted at the same queue will be batch inserted.
 
 Contexts allow you to build workflows easily,
 
-    from furious import Async
+    from furious.async import Async
     from furious.context import get_current_context, new
 
     def square_a_number(number):
@@ -121,7 +136,7 @@ Contexts allow you to build workflows easily,
 
 Asyncs and Contexts maybe nested to build more complex workflows.
 
-    from furious import Async
+    from furious.async import Async
     from furious.context import new
 
     def do_some_work(number):

aviary.yaml

@@ -0,0 +1,15 @@
+version: 1
+
+exclude:
+  - tests?/
+
+raven_monitored_classes: null
+
+raven_monitored_files:
+  ^furious/extras/xsrf.py$:
+    reason: CSRF protection helper methods
+
+raven_monitored_functions: null
+
+raven_monitored_keywords: null
+

doc/Makefile

@@ -0,0 +1,153 @@
+# 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) source
+# the i18n builder cannot share the environment and doctrees with the others
+I18NSPHINXOPTS  = $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) source
+
+.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 <target>' where <target> 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 "  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 "  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/furious.qhcp"
+	@echo "To view the help file:"
+	@echo "# assistant -collectionFile $(BUILDDIR)/qthelp/furious.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/furious"
+	@echo "# ln -s $(BUILDDIR)/devhelp $$HOME/.local/share/devhelp/furious"
+	@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."
+
+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."

doc/how_to_build_docs.txt

@@ -0,0 +1,33 @@
+1. You must have a .pth file in your site-packages directory with
+the path of your google_appengine sdk. For Unix environments just create a file here:
+
+$VIRTUAL_ENV/lib/python2.7/site-packages/appengine.pth
+
+with the path:
+
+/usr/local/google_appengine
+
+
+2. Install the requirements:
+
+    $ pip install -r doc/requirements.txt
+
+
+3. Auto build doc source from project source (run from the doc directory):
+(http://sphinx-doc.org/invocation.html#invocation-apidoc)
+    $ sphinx-apidoc -T -s txt -o source ../furious
+    $ sphinx-apidoc -T -s txt -o source ../example
+
+to force rebuild the rsts, include -f:
+(http://sphinx-doc.org/invocation.html)
+    $ sphinx-apidoc -T -f -s txt -o source ../furious
+    $ sphinx-apidoc -T -f -s txt -o source ../example
+
+
+4. Build docs from source:
+    $ make html
+
+Sometimes the docs don't update and you need to remove doc/build/doctrees:
+    $ rm -Rf build/doctrees
+
+