[Python-modules-commits] [vine] 01/04: Import vine_1.1.3+dfsg.orig.tar.gz
Christopher Stuart Hoskin
mans0954 at moszumanska.debian.org
Thu Feb 16 17:28:45 UTC 2017
This is an automated email from the git hooks/post-receive script.
mans0954 pushed a commit to branch master
in repository vine.
commit 6633143b4f28ec57dab8a04dbbd2e8ca1bbadc43
Author: Christopher Hoskin <christopher.hoskin at gmail.com>
Date: Thu Feb 16 16:01:12 2017 +0000
Import vine_1.1.3+dfsg.orig.tar.gz
---
Changelog | 113 ++++++++++
LICENSE | 52 +++++
MANIFEST.in | 10 +
PKG-INFO | 59 ++++++
README.rst | 39 ++++
docs/Makefile | 228 +++++++++++++++++++++
docs/_static/.keep | 0
docs/_templates/sidebardonations.html | 10 +
docs/changelog.rst | 1 +
docs/conf.py | 25 +++
docs/images/celery_128.png | Bin 0 -> 22031 bytes
docs/images/favicon.ico | Bin 0 -> 4286 bytes
docs/includes/introduction.txt | 9 +
docs/index.rst | 22 ++
docs/make.bat | 272 +++++++++++++++++++++++++
docs/reference/index.rst | 18 ++
docs/reference/vine.abstract.rst | 11 +
docs/reference/vine.five.rst | 11 +
docs/reference/vine.funtools.rst | 11 +
docs/reference/vine.promises.rst | 11 +
docs/reference/vine.synchronization.rst | 11 +
docs/reference/vine.utils.rst | 11 +
docs/templates/readme.txt | 30 +++
requirements/docs.txt | 1 +
requirements/pkgutils.txt | 8 +
requirements/test-ci.txt | 2 +
requirements/test.txt | 2 +
setup.cfg | 18 ++
setup.py | 115 +++++++++++
t/__init__.py | 0
t/unit/__init__.py | 0
t/unit/conftest.py | 22 ++
t/unit/test_abstract.py | 24 +++
t/unit/test_funtools.py | 85 ++++++++
t/unit/test_promises.py | 325 +++++++++++++++++++++++++++++
t/unit/test_synchronization.py | 54 +++++
vine/__init__.py | 41 ++++
vine/abstract.py | 74 +++++++
vine/five.py | 351 ++++++++++++++++++++++++++++++++
vine/funtools.py | 115 +++++++++++
vine/promises.py | 219 ++++++++++++++++++++
vine/synchronization.py | 96 +++++++++
vine/utils.py | 25 +++
43 files changed, 2531 insertions(+)
diff --git a/Changelog b/Changelog
new file mode 100644
index 0000000..bfce549
--- /dev/null
+++ b/Changelog
@@ -0,0 +1,113 @@
+Changes
+=======
+
+.. _version-1.3.3:
+
+1.1.3
+=====
+:release-date: 2016-10-13 06:02 P.M PDT
+:release-by: Ask Solem
+
+- New ``promise(fun, weak=True)`` argument, creates weakref to callback.
+
+.. _version-1.1.2:
+
+1.1.2
+=====
+:release-date: 2016-09-07 04:18 P.M PDT
+:release-by: Ask Solem
+
+- barrier: now handles the case where len(promises) returns NotImplemented.
+
+.. _version-1.1.1:
+
+1.1.1
+=====
+:release-date: 2016-06-30 12:05 P.M PDT
+:release-by: Ask Solem
+
+- Requirements: Tests now depends on :pypi:`case` 1.2.2
+
+- Five: python_2_unicode_compatible now ensures `__repr__` returns
+ bytes on Python 2.
+
+.. _version-1.1.0:
+
+1.1.0
+=====
+:release-date: 2016-04-21 01:30 P.M PDT
+:release-by: Ask Solem
+
+- :meth:`promise.throw() <vine.promises.promise.throw>` now passes partial
+ args/kwargs to the errback:
+
+ .. code-block:: pycon
+
+ >>> p = promise(args=(self,), on_error=handle_error)
+ >>> p.throw(exc) # --> handle_error(self, exc)
+
+- New :class:`vine.abstract.ThenableProxy` can be used to add
+ promise-capabilities to a class by forwarding to a different promise.
+
+ .. code-block:: python
+
+ from vine import promise
+ from vine.abstract import ThenableProxy
+
+ class P(ThenableProxy):
+
+ def __init__(self, on_success=None, on_error=None):
+ self._set_promise_target(promise(
+ args=(self,), callback=on_success, on_error=on_error,
+ ))
+
+ p = P()
+ p.then(download_file(url)).then(extract_file)
+
+- :meth:`promise.throw() <vine.promises.promise.throw>` now supports a propagate
+ argument that can be set to False to never reraise the exception.
+
+- :meth:`promise.throw() <vine.promises.promise.throw>` now also reraises the
+ current exception from the stack, if the exc argument is passed and that
+ value is the same as the current exception.
+
+- :meth:`Thenable.register() <vine.abstract.Thenable.register>` can now be
+ used as a decorator.
+
+- Argument to :meth:`promise.throw1(exc) <vine.promises.promise.throw1>` can now be
+ :const:`None` to use the current exception.
+
+- ``monotonic()`` now uses ``librt.so.0`` as an alternative if ``librt.so.1``
+ does not exist.
+
+ Contributed by Fahad Siddiqui.
+
+.. _version-1.0.2:
+
+1.0.2
+=====
+:release-date: 2016-04-11 05:30 P.M PDT
+:release-by: Ask Solem
+
+- ``promise.throw()`` now supports second ``traceback`` argument to
+ throw exception with specific traceback.
+
+ Contributed by Ionel Cristian Mărieș.
+
+.. _version-1.0.1:
+
+1.0.1
+=====
+:release-date: 2016-04-11 03:00 P.M PDT
+:release-by: Ask Solem
+
+- Adds vine.five.python_2_unicode_compatible.
+
+.. _version-1.0.0:
+
+1.0.0
+=====
+:release-date: 2016-04-07 06:02 P.M PDT
+:release-by: Ask Solem
+
+- Initial release.
diff --git a/LICENSE b/LICENSE
new file mode 100644
index 0000000..0a94912
--- /dev/null
+++ b/LICENSE
@@ -0,0 +1,52 @@
+Copyright (c) 2015-2016 Ask Solem & contributors. All rights reserved.
+
+Vine is licensed under The BSD License (3 Clause, also known as
+the new BSD license). The license is an OSI approved Open Source
+license and is GPL-compatible(1).
+
+The license text can also be found here:
+http://www.opensource.org/licenses/BSD-3-Clause
+
+License
+=======
+
+Redistribution and use in source and binary forms, with or without
+modification, are permitted provided that the following conditions are met:
+ * Redistributions of source code must retain the above copyright
+ notice, this list of conditions and the following disclaimer.
+ * Redistributions in binary form must reproduce the above copyright
+ notice, this list of conditions and the following disclaimer in the
+ documentation and/or other materials provided with the distribution.
+ * Neither the name of Ask Solem, nor the
+ names of its contributors may be used to endorse or promote products
+ derived from this software without specific prior written permission.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
+THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
+PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL Ask Solem OR CONTRIBUTORS
+BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
+CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
+SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
+INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
+CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
+ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
+POSSIBILITY OF SUCH DAMAGE.
+
+Documentation License
+=====================
+
+The documentation portion of Vine (the rendered contents of the
+"docs" directory of a software distribution or checkout) is supplied
+under the "Creative Commons Attribution-ShareAlike 4.0
+International" (CC BY-SA 4.0) License as described by
+http://creativecommons.org/licenses/by-sa/4.0/
+
+Footnotes
+=========
+(1) A GPL-compatible license makes it possible to
+ combine Vine with other software that is released
+ under the GPL, it does not mean that we're distributing
+ Vine under the GPL license. The BSD license, unlike the GPL,
+ let you distribute a modified version without making your
+ changes open source.
diff --git a/MANIFEST.in b/MANIFEST.in
new file mode 100644
index 0000000..c703e7f
--- /dev/null
+++ b/MANIFEST.in
@@ -0,0 +1,10 @@
+include README.rst Changelog LICENSE
+recursive-include docs *
+recursive-include extra README *.py
+recursive-include requirements *.txt
+recursive-include t *.py
+
+recursive-exclude docs/_build *
+recursive-exclude * __pycache__
+recursive-exclude * *.py[co]
+recursive-exclude * .*.sw*
diff --git a/PKG-INFO b/PKG-INFO
new file mode 100644
index 0000000..048cd00
--- /dev/null
+++ b/PKG-INFO
@@ -0,0 +1,59 @@
+Metadata-Version: 1.1
+Name: vine
+Version: 1.1.3
+Summary: Promises, promises, promises.
+Home-page: http://github.com/celery/vine
+Author: Ask Solem
+Author-email: ask at celeryproject.org
+License: BSD
+Description: =====================================================================
+ vine - Python Promises
+ =====================================================================
+
+ |build-status| |coverage| |license| |wheel| |pyversion| |pyimp|
+
+ :Version: 1.1.3
+ :Web: https://vine.readthedocs.io/
+ :Download: http://pypi.python.org/pypi/vine/
+ :Source: http://github.com/celery/vine/
+ :Keywords: promise, async, future
+
+ About
+ =====
+
+
+ .. |build-status| image:: https://secure.travis-ci.org/celery/vine.png?branch=master
+ :alt: Build status
+ :target: https://travis-ci.org/celery/vine
+
+ .. |coverage| image:: https://codecov.io/github/celery/vine/coverage.svg?branch=master
+ :target: https://codecov.io/github/celery/vine?branch=master
+
+ .. |license| image:: https://img.shields.io/pypi/l/vine.svg
+ :alt: BSD License
+ :target: https://opensource.org/licenses/BSD-3-Clause
+
+ .. |wheel| image:: https://img.shields.io/pypi/wheel/vine.svg
+ :alt: Vine can be installed via wheel
+ :target: http://pypi.python.org/pypi/vine/
+
+ .. |pyversion| image:: https://img.shields.io/pypi/pyversions/vine.svg
+ :alt: Supported Python versions.
+ :target: http://pypi.python.org/pypi/vine/
+
+ .. |pyimp| image:: https://img.shields.io/pypi/implementation/vine.svg
+ :alt: Support Python implementations.
+ :target: http://pypi.python.org/pypi/vine/
+
+
+Keywords: promise promises lazy future futures
+Platform: any
+Classifier: Development Status :: 5 - Production/Stable
+Classifier: Programming Language :: Python
+Classifier: Programming Language :: Python :: 2
+Classifier: Programming Language :: Python :: 2.7
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.4
+Classifier: License :: OSI Approved :: BSD License
+Classifier: Intended Audience :: Developers
+Classifier: Operating System :: OS Independent
diff --git a/README.rst b/README.rst
new file mode 100644
index 0000000..1af8c81
--- /dev/null
+++ b/README.rst
@@ -0,0 +1,39 @@
+=====================================================================
+ vine - Python Promises
+=====================================================================
+
+|build-status| |coverage| |license| |wheel| |pyversion| |pyimp|
+
+:Version: 1.1.3
+:Web: https://vine.readthedocs.io/
+:Download: http://pypi.python.org/pypi/vine/
+:Source: http://github.com/celery/vine/
+:Keywords: promise, async, future
+
+About
+=====
+
+
+.. |build-status| image:: https://secure.travis-ci.org/celery/vine.png?branch=master
+ :alt: Build status
+ :target: https://travis-ci.org/celery/vine
+
+.. |coverage| image:: https://codecov.io/github/celery/vine/coverage.svg?branch=master
+ :target: https://codecov.io/github/celery/vine?branch=master
+
+.. |license| image:: https://img.shields.io/pypi/l/vine.svg
+ :alt: BSD License
+ :target: https://opensource.org/licenses/BSD-3-Clause
+
+.. |wheel| image:: https://img.shields.io/pypi/wheel/vine.svg
+ :alt: Vine can be installed via wheel
+ :target: http://pypi.python.org/pypi/vine/
+
+.. |pyversion| image:: https://img.shields.io/pypi/pyversions/vine.svg
+ :alt: Supported Python versions.
+ :target: http://pypi.python.org/pypi/vine/
+
+.. |pyimp| image:: https://img.shields.io/pypi/implementation/vine.svg
+ :alt: Support Python implementations.
+ :target: http://pypi.python.org/pypi/vine/
+
diff --git a/docs/Makefile b/docs/Makefile
new file mode 100644
index 0000000..457f4aa
--- /dev/null
+++ b/docs/Makefile
@@ -0,0 +1,228 @@
+# 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
+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 " 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 " apicheck to make sure all modules are documented by autodoc"
+
+.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/PROJ.qhcp"
+ @echo "To view the help file:"
+ @echo "# assistant -collectionFile $(BUILDDIR)/qthelp/PROJ.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/PROJ"
+ @echo "# ln -s $(BUILDDIR)/devhelp $$HOME/.local/share/devhelp/PROJ"
+ @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: apicheck
+apicheck:
+ $(SPHINXBUILD) -b apicheck $(ALLSPHINXOPTS) $(BUILDDIR)/apicheck
+
+.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."
diff --git a/docs/_static/.keep b/docs/_static/.keep
new file mode 100644
index 0000000..e69de29
diff --git a/docs/_templates/sidebardonations.html b/docs/_templates/sidebardonations.html
new file mode 100644
index 0000000..90c930b
--- /dev/null
+++ b/docs/_templates/sidebardonations.html
@@ -0,0 +1,10 @@
+<div id="donate">
+ <b>Donations welcome:</b>
+ <form action="https://www.paypal.com/cgi-bin/webscr" method="post" target="_top">
+ <input type="hidden" name="cmd" value="_s-xclick">
+ <input type="hidden" name="encrypted" value="-----BEGIN PKCS7-----MIIHTwYJKoZIhvcNAQcEoIIHQDCCBzwCAQExggEwMIIBLAIBADCBlDCBjjELMAkGA1UEBhMCVVMxCzAJBgNVBAgTAkNBMRYwFAYDVQQHEw1Nb3VudGFpbiBWaWV3MRQwEgYDVQQKEwtQYXlQYWwgSW5jLjETMBEGA1UECxQKbGl2ZV9jZXJ0czERMA8GA1UEAxQIbGl2ZV9hcGkxHDAaBgkqhkiG9w0BCQEWDXJlQHBheXBhbC5jb20CAQAwDQYJKoZIhvcNAQEBBQAEgYA2+c723xlntHKQYQR9yn9BEtUhDoUUlnOqhniqvNMWB4k2R0JpVkrNSu5JCbdjNOqDXKHoRfIWe3HXJJMPZBJKFMD5Izprb6xEZlTGaWnlrGXFfkdBaILQQgWYqV0DnuNmtDXCvfYmyu0p1K04wL [...]
+ ">
+ <input type="image" src="https://www.paypalobjects.com/en_US/i/btn/btn_donateCC_LG.gif" border="0" name="submit" alt="PayPal - The safer, easier way to pay online!">
+ <img alt="" border="0" src="https://www.paypalobjects.com/en_US/i/scr/pixel.gif" width="1" height="1">
+ </form>
+</div>
diff --git a/docs/changelog.rst b/docs/changelog.rst
new file mode 100644
index 0000000..5b20da3
--- /dev/null
+++ b/docs/changelog.rst
@@ -0,0 +1 @@
+.. include:: ../Changelog
diff --git a/docs/conf.py b/docs/conf.py
new file mode 100644
index 0000000..6b5e600
--- /dev/null
+++ b/docs/conf.py
@@ -0,0 +1,25 @@
+# -*- coding: utf-8 -*-
+from __future__ import absolute_import, unicode_literals
+
+from sphinx_celery import conf
+
+globals().update(conf.build_config(
+ 'vine', __file__,
+ project='Vine',
+ description='Python Promises',
+ # version_dev='2.0',
+ # version_stable='1.0',
+ canonical_url='https://vine.readthedocs.io',
+ webdomain='celeryproject.org',
+ github_project='celery/vine',
+ author='Ask Solem & contributors',
+ author_name='Ask Solem',
+ copyright='2016',
+ publisher='Celery Project',
+ html_logo='images/celery_128.png',
+ html_favicon='images/favicon.ico',
+ html_prepend_sidebars=['sidebardonations.html'],
+ extra_extensions=[],
+ include_intersphinx={'python', 'sphinx'},
+ apicheck_ignore_modules=['vine'],
+))
diff --git a/docs/images/celery_128.png b/docs/images/celery_128.png
new file mode 100644
index 0000000..1a4fd77
Binary files /dev/null and b/docs/images/celery_128.png differ
diff --git a/docs/images/favicon.ico b/docs/images/favicon.ico
new file mode 100644
index 0000000..da7087f
Binary files /dev/null and b/docs/images/favicon.ico differ
diff --git a/docs/includes/introduction.txt b/docs/includes/introduction.txt
new file mode 100644
index 0000000..0593aaf
--- /dev/null
+++ b/docs/includes/introduction.txt
@@ -0,0 +1,9 @@
+:Version: 1.1.3
+:Web: https://vine.readthedocs.io/
+:Download: http://pypi.python.org/pypi/vine/
+:Source: http://github.com/celery/vine/
+:Keywords: promise, async, future
+
+About
+=====
+
diff --git a/docs/index.rst b/docs/index.rst
new file mode 100644
index 0000000..d5c986a
--- /dev/null
+++ b/docs/index.rst
@@ -0,0 +1,22 @@
+=============================================
+ vine - Python Promises
+=============================================
+
+.. include:: includes/introduction.txt
+
+Contents
+========
+
+.. toctree::
+ :maxdepth: 2
+
+ reference/index
+ changelog
+
+Indices and tables
+==================
+
+* :ref:`genindex`
+* :ref:`modindex`
+* :ref:`search`
+
diff --git a/docs/make.bat b/docs/make.bat
new file mode 100644
index 0000000..a75aa4e
--- /dev/null
+++ b/docs/make.bat
@@ -0,0 +1,272 @@
+ at 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 ^<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. epub3 to make an epub3
+ 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
+ echo. coverage to run coverage check of 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
+)
+
+
+REM Check if sphinx-build is available and fallback to Python version if any
+%SPHINXBUILD% 1>NUL 2>NUL
+if errorlevel 9009 goto sphinx_python
+goto sphinx_ok
+
+:sphinx_python
+
+set SPHINXBUILD=python -m sphinx.__init__
+%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
+)
+
+:sphinx_ok
+
+
+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\PROJ.qhcp
+ echo.To view the help file:
+ echo.^> assistant -collectionFile %BUILDDIR%\qthelp\PROJ.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" == "epub3" (
+ %SPHINXBUILD% -b epub3 %ALLSPHINXOPTS% %BUILDDIR%/epub3
+ if errorlevel 1 exit /b 1
+ echo.
+ echo.Build finished. The epub3 file is in %BUILDDIR%/epub3.
+ 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 %~dp0
+ 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 %~dp0
+ 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" == "coverage" (
+ %SPHINXBUILD% -b coverage %ALLSPHINXOPTS% %BUILDDIR%/coverage
+ if errorlevel 1 exit /b 1
+ echo.
+ echo.Testing of coverage in the sources finished, look at the ^
+results in %BUILDDIR%/coverage/python.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
diff --git a/docs/reference/index.rst b/docs/reference/index.rst
new file mode 100644
index 0000000..f781878
--- /dev/null
+++ b/docs/reference/index.rst
@@ -0,0 +1,18 @@
+.. _apiref:
+
+===============
+ API Reference
+===============
+
+:Release: |version|
+:Date: |today|
+
+.. toctree::
+ :maxdepth: 1
+
+ vine.promises
+ vine.synchronization
+ vine.funtools
+ vine.abstract
+ vine.five
+ vine.utils
diff --git a/docs/reference/vine.abstract.rst b/docs/reference/vine.abstract.rst
new file mode 100644
... 1827 lines suppressed ...
--
Alioth's /usr/local/bin/git-commit-notice on /srv/git.debian.org/git/python-modules/packages/vine.git
More information about the Python-modules-commits
mailing list