Permalink
Browse files

Start the project

  • Loading branch information...
1 parent ed2d9f1 commit 90f68239696c530e41fe70e4eac9f9ee9281954b @ajdavis committed Dec 1, 2012
Showing with 1,054 additions and 4 deletions.
  1. +13 −0 LICENSE
  2. +9 −0 MANIFEST.in
  3. +0 −4 README.md
  4. +36 −0 README.rst
  5. +3 −0 cover.sh
  6. +153 −0 doc/Makefile
  7. +7 −0 doc/changelog.rst
  8. +27 −0 doc/classes.rst
  9. +257 −0 doc/conf.py
  10. +6 −0 doc/examples/index.rst
  11. +7 −0 doc/faq.rst
  12. +91 −0 doc/index.rst
  13. 0 examples/__init__.py
  14. +1 −0 requirements.txt
  15. +3 −0 setup.cfg
  16. +53 −0 setup.py
  17. +1 −0 test/__init__.py
  18. +120 −0 test/async_test_engine.py
  19. +149 −0 test/test_yieldpoints.py
  20. +11 −0 tox.ini
  21. +107 −0 yieldpoints/__init__.py
View
13 LICENSE
@@ -0,0 +1,13 @@
+YieldPoints Copyright (c) 2012 A. Jesse Jiryu Davis
+
+Licensed under the Apache License, Version 2.0 (the "License"); you may
+not use this file except in compliance with the License. You may obtain
+a copy of the License at
+
+http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
+WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
+License for the specific language governing permissions and limitations
+under the License.
View
@@ -0,0 +1,9 @@
+include README.rst
+include LICENSE
+recursive-include doc *.rst
+recursive-include doc *.py
+recursive-include doc *.png
+recursive-include doc Makefile
+prune doc/_build
+recursive-include examples *.py
+
View
@@ -1,4 +0,0 @@
-waitany
-=======
-
-Simple tornado.gen extension, waits until the first of several tasks completes
View
@@ -0,0 +1,36 @@
+===========
+YieldPoints
+===========
+
+:Info: Synchronization primitives for Tornado coroutines.
+:Author: A\. Jesse Jiryu Davis
+
+About
+=====
+Simple extensions to Tornado's gen_ module.
+
+.. _gen: http://www.tornadoweb.org/documentation/gen.html
+
+Dependencies
+============
+Tornado_ >= version 2.3.
+
+.. _Tornado: http://www.tornadoweb.org/
+
+
+Documentation
+=============
+
+Documentation: http://yieldpoints.readthedocs.org/
+
+You will need Sphinx_ installed to generate the
+documentation. Documentation can be generated like::
+
+ $ sphinx-build doc build
+
+.. _Sphinx: http://sphinx.pocoo.org/
+
+Testing
+=======
+
+Run ``python setup.py nosetests`` in the root directory.
View
@@ -0,0 +1,3 @@
+PYTHONPATH=../lib/python2.7/site-packages coverage run --branch --source yieldpoints/__init__.py /Users/emptysquare/.virtualenvs/yieldpoints/bin/nosetests -vs
+rm -rf html
+coverage html -d html
View
@@ -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) .
+# 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 <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/YieldPoints.qhcp"
+ @echo "To view the help file:"
+ @echo "# assistant -collectionFile $(BUILDDIR)/qthelp/YieldPoints.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/YieldPoints"
+ @echo "# ln -s $(BUILDDIR)/devhelp $$HOME/.local/share/devhelp/YieldPoints"
+ @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."
View
@@ -0,0 +1,7 @@
+Changelog
+=========
+
+Version 0.1
+-----------
+
+First release.
View
@@ -0,0 +1,27 @@
+:mod:`yieldpoints` Classes
+==========================
+
+.. currentmodule:: yieldpoints
+
+.. contents:: Contents
+ :local:
+
+WaitAny
+-----------
+.. autoclass:: WaitAny
+ :members:
+
+Cancel
+------
+.. autoclass:: Cancel
+ :members:
+
+CancelAll
+---------
+.. autoclass:: CancelAll
+ :members:
+
+Timeout
+-------
+.. autoclass:: Timeout
+ :members:
Oops, something went wrong.

0 comments on commit 90f6823

Please sign in to comment.