[Python-modules-commits] [panoramisk] 01/08: import panoramisk_1.0.orig.tar.gz
Orestis Ioannou
oorestisime-guest at moszumanska.debian.org
Mon Aug 22 20:41:54 UTC 2016
This is an automated email from the git hooks/post-receive script.
oorestisime-guest pushed a commit to branch master
in repository panoramisk.
commit 86374c4b10e82edf985aeb620ab4ce377cf3a2dd
Author: Orestis Ioannou <orestis at oioannou.com>
Date: Sun Jul 3 23:52:41 2016 +0200
import panoramisk_1.0.orig.tar.gz
---
.coveragerc | 14 +
CHANGES.rst | 46 +
LICENSE | 21 +
MANIFEST.in | 14 +
PKG-INFO | 87 +
README.rst | 66 +
bootstrap.py | 183 +
buildout.cfg | 20 +
docs/Makefile | 153 +
docs/actions.rst | 12 +
docs/conf.py | 247 +
docs/conftest.py | 9 +
docs/index.rst | 57 +
docs/message.rst | 8 +
docs/testing.rst | 21 +
examples/fast_agi_server.py | 32 +
examples/fast_agi_server_ivr.py | 44 +
examples/get_extension_status.py | 17 +
examples/originate.py | 31 +
examples/queue_status.py | 15 +
panoramisk.egg-info/PKG-INFO | 87 +
panoramisk.egg-info/SOURCES.txt | 57 +
panoramisk.egg-info/dependency_links.txt | 1 +
panoramisk.egg-info/entry_points.txt | 4 +
panoramisk.egg-info/not-zip-safe | 1 +
panoramisk.egg-info/requires.txt | 8 +
panoramisk.egg-info/top_level.txt | 1 +
panoramisk/__init__.py | 7 +
panoramisk/actions.py | 128 +
panoramisk/call_manager.py | 54 +
panoramisk/connection.py | 87 +
panoramisk/fast_agi.py | 163 +
panoramisk/manager.py | 225 +
panoramisk/message.py | 119 +
panoramisk/scripts.py | 79 +
panoramisk/testing.py | 64 +
panoramisk/utils.py | 185 +
setup.cfg | 16 +
setup.py | 69 +
tests/fixtures/agent_loggued_in.yaml | 1350 +++++
tests/fixtures/agent_not_in_pause.yaml | 609 ++
.../fixtures/asyncagi_channel_does_not_exist.yaml | 11 +
tests/fixtures/asyncagi_get_var.yaml | 33 +
tests/fixtures/command_core_show_version.yaml | 11 +
tests/fixtures/login_failed.yaml | 11 +
tests/fixtures/login_ok.yaml | 15 +
tests/fixtures/logoff.yaml | 8 +
tests/fixtures/originate_sync.yaml | 14 +
tests/fixtures/originate_with_events.yaml | 6360 ++++++++++++++++++++
tests/fixtures/ping.yaml | 6 +
tests/fixtures/queue_status.yaml | 106 +
tests/fixtures/rasterisk_command.yaml | 13 +
tests/fixtures/sip_notify.yaml | 13 +
tests/test_manager.py | 156 +
tests/test_message.py | 31 +
tests/test_protocol.py | 26 +
tests_python3/test_fast_agi.py | 63 +
tox.ini | 54 +
58 files changed, 11342 insertions(+)
diff --git a/.coveragerc b/.coveragerc
new file mode 100644
index 0000000..966cfc4
--- /dev/null
+++ b/.coveragerc
@@ -0,0 +1,14 @@
+[run]
+omit =
+ */panoramisk/scripts.py
+ */panoramisk/call_manager.py
+include =
+ */panoramisk/panoramisk/*
+
+[report]
+exclude_lines =
+ pragma: no cover
+ def __repr__
+ raise NotImplementedError
+ if __name__ == .__main__.:
+ def parse_args
diff --git a/CHANGES.rst b/CHANGES.rst
new file mode 100644
index 0000000..e99ca8d
--- /dev/null
+++ b/CHANGES.rst
@@ -0,0 +1,46 @@
+1.0 (2015-08-19)
+================
+
+- Add FastAGI server, implemented with high-level AsyncIO API (Streams)
+- Add events parameter for Manager, to disable AMI events reception (Useful for performance reasons)
+- Finish AsyncAGI commands support (WIP)
+
+0.6 (2014-11-16)
+================
+
+- Avoid failure when factory is not already set
+
+0.5 (2014-11-16)
+================
+
+- AMI command results tracking fixed
+- Return AMI command result with multiple events in a Future
+- Return AsyncAGI command result in a Future
+- Add several examples
+- Internal refactoring
+- Remove arawman support
+- Remove external dependencies
+- Add support for multiple responses from Actions (example: QueueStatus)
+- Improved performance with Events pattern matching
+- Add mocked test wrapper
+- Add coroutine support for Events dispatching
+- Invert event callback signature to create Manager methods to handle events
+- Support of AMI commands
+- Support of AsyncAGI commands (Not finished)
+
+0.4 (2014-05-30)
+================
+
+- Compat with the latest trollius
+
+
+0.3 (2014-01-10)
+================
+
+- Don't send commands twice
+
+
+0.2 (2014-01-09)
+================
+
+- Initial release
diff --git a/LICENSE b/LICENSE
new file mode 100644
index 0000000..72ad143
--- /dev/null
+++ b/LICENSE
@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 Gael Pasgrimaud
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.
diff --git a/MANIFEST.in b/MANIFEST.in
new file mode 100644
index 0000000..e7a5dc4
--- /dev/null
+++ b/MANIFEST.in
@@ -0,0 +1,14 @@
+graft examples
+graft docs
+prune docs/_build
+graft panoramisk
+graft tests
+graft tests_python3
+include *.rst *.cfg *.ini .coveragerc LICENCE
+global-exclude *.pyc
+global-exclude __pycache__
+include *.py
+include .coveragerc
+include LICENSE
+recursive-include examples *.py
+recursive-include tests_python3 *.py
diff --git a/PKG-INFO b/PKG-INFO
new file mode 100644
index 0000000..832abec
--- /dev/null
+++ b/PKG-INFO
@@ -0,0 +1,87 @@
+Metadata-Version: 1.1
+Name: panoramisk
+Version: 1.0
+Summary: asyncio based library to play with asterisk
+Home-page: https://github.com/gawel/panoramisk/
+Author: Gael Pasgrimaud
+Author-email: gael at gawel.org
+License: MIT license
+Description: ================================
+ Panoramisk. The Asterisk's druid
+ ================================
+
+ .. image:: https://travis-ci.org/gawel/panoramisk.png?branch=master&style=flat-square
+ :target: https://travis-ci.org/gawel/panoramisk
+
+ .. image:: https://img.shields.io/coveralls/gawel/panoramisk/master.svg
+ :target: https://coveralls.io/r/gawel/panoramisk?branch=master
+
+ .. image:: https://img.shields.io/pypi/v/panoramisk.svg?style=flat-square
+ :target: https://pypi.python.org/pypi/panoramisk
+
+ .. image:: https://img.shields.io/pypi/dw/panoramisk.svg?style=flat-square
+ :target: https://pypi.python.org/pypi/panoramisk
+
+ .. image:: https://img.shields.io/github/issues/gawel/panoramisk.svg?style=flat-square
+ :target: https://github.com/gawel/panoramisk/issues
+
+ .. image:: https://img.shields.io/github/license/gawel/panoramisk.svg?style=flat-square
+ :target: https://github.com/gawel/panoramisk/blob/master/LICENSE
+
+
+ `Panoramisk` is a library based on python's `AsyncIO
+ <http://docs.python.org/dev/library/asyncio.html>`_ to play with `Asterisk
+ <http://www.asterisk.org/community/documentation>`_'s `manager
+ <https://wiki.asterisk.org/wiki/display/AST/The+Asterisk+Manager+TCP+IP+API>`_.
+
+ It uses the TCP manager server to listen to events and send actions.
+
+ For basic usage, you have some examples in `examples/
+ <https://github.com/gawel/panoramisk/tree/master/examples>`_ folder.
+
+ You can find some help on IRC: irc://irc.freenode.net/panoramisk (`www
+ <https://kiwiirc.com/client/irc.freenode.net/?nick=panoramisk|?&theme=basic#panoramisk>`_)
+
+
+ Running the Tests
+ -----------------
+
+ Running your test with::
+
+ $ python setup.py test
+ $ py.test tests/ docs/
+
+
+ Source code
+ -----------
+
+ Find us on Github at https://github.com/gawel/panoramisk/
+
+
+ Documentation
+ -------------
+
+ Check out the documentation on Read the Docs: https://panoramisk.readthedocs.org/
+
+
+ Installation
+ ------------
+
+ Install, upgrade and uninstall panoramisk with these commands::
+
+ $ pip install panoramisk
+ $ pip install --upgrade panoramisk
+ $ pip uninstall panoramisk
+
+Keywords: asyncio,asterisk,voip
+Platform: UNKNOWN
+Classifier: Development Status :: 5 - Production/Stable
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python
+Classifier: Programming Language :: Python :: 2.7
+Classifier: Programming Language :: Python :: 3.3
+Classifier: Programming Language :: Python :: 3.4
+Classifier: Topic :: Communications :: Telephony
+Classifier: Topic :: Software Development :: Libraries :: Python Modules
diff --git a/README.rst b/README.rst
new file mode 100644
index 0000000..e4cdf2c
--- /dev/null
+++ b/README.rst
@@ -0,0 +1,66 @@
+================================
+Panoramisk. The Asterisk's druid
+================================
+
+.. image:: https://travis-ci.org/gawel/panoramisk.png?branch=master&style=flat-square
+ :target: https://travis-ci.org/gawel/panoramisk
+
+.. image:: https://img.shields.io/coveralls/gawel/panoramisk/master.svg
+ :target: https://coveralls.io/r/gawel/panoramisk?branch=master
+
+.. image:: https://img.shields.io/pypi/v/panoramisk.svg?style=flat-square
+ :target: https://pypi.python.org/pypi/panoramisk
+
+.. image:: https://img.shields.io/pypi/dw/panoramisk.svg?style=flat-square
+ :target: https://pypi.python.org/pypi/panoramisk
+
+.. image:: https://img.shields.io/github/issues/gawel/panoramisk.svg?style=flat-square
+ :target: https://github.com/gawel/panoramisk/issues
+
+.. image:: https://img.shields.io/github/license/gawel/panoramisk.svg?style=flat-square
+ :target: https://github.com/gawel/panoramisk/blob/master/LICENSE
+
+
+`Panoramisk` is a library based on python's `AsyncIO
+<http://docs.python.org/dev/library/asyncio.html>`_ to play with `Asterisk
+<http://www.asterisk.org/community/documentation>`_'s `manager
+<https://wiki.asterisk.org/wiki/display/AST/The+Asterisk+Manager+TCP+IP+API>`_.
+
+It uses the TCP manager server to listen to events and send actions.
+
+For basic usage, you have some examples in `examples/
+<https://github.com/gawel/panoramisk/tree/master/examples>`_ folder.
+
+You can find some help on IRC: irc://irc.freenode.net/panoramisk (`www
+<https://kiwiirc.com/client/irc.freenode.net/?nick=panoramisk|?&theme=basic#panoramisk>`_)
+
+
+Running the Tests
+-----------------
+
+Running your test with::
+
+ $ python setup.py test
+ $ py.test tests/ docs/
+
+
+Source code
+-----------
+
+Find us on Github at https://github.com/gawel/panoramisk/
+
+
+Documentation
+-------------
+
+Check out the documentation on Read the Docs: https://panoramisk.readthedocs.org/
+
+
+Installation
+------------
+
+Install, upgrade and uninstall panoramisk with these commands::
+
+ $ pip install panoramisk
+ $ pip install --upgrade panoramisk
+ $ pip uninstall panoramisk
diff --git a/bootstrap.py b/bootstrap.py
new file mode 100755
index 0000000..60629f5
--- /dev/null
+++ b/bootstrap.py
@@ -0,0 +1,183 @@
+##############################################################################
+#
+# Copyright (c) 2006 Zope Foundation and Contributors.
+# All Rights Reserved.
+#
+# This software is subject to the provisions of the Zope Public License,
+# Version 2.1 (ZPL). A copy of the ZPL should accompany this distribution.
+# THIS SOFTWARE IS PROVIDED "AS IS" AND ANY AND ALL EXPRESS OR IMPLIED
+# WARRANTIES ARE DISCLAIMED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
+# WARRANTIES OF TITLE, MERCHANTABILITY, AGAINST INFRINGEMENT, AND FITNESS
+# FOR A PARTICULAR PURPOSE.
+#
+##############################################################################
+"""Bootstrap a buildout-based project
+
+Simply run this script in a directory containing a buildout.cfg.
+The script accepts buildout command-line options, so you can
+use the -c option to specify an alternate configuration file.
+"""
+
+import os
+import shutil
+import sys
+import tempfile
+
+from optparse import OptionParser
+
+tmpeggs = tempfile.mkdtemp()
+
+usage = '''\
+[DESIRED PYTHON FOR BUILDOUT] bootstrap.py [options]
+
+Bootstraps a buildout-based project.
+
+Simply run this script in a directory containing a buildout.cfg, using the
+Python that you want bin/buildout to use.
+
+Note that by using --find-links to point to local resources, you can keep
+this script from going over the network.
+'''
+
+parser = OptionParser(usage=usage)
+parser.add_option("-v", "--version", help="use a specific zc.buildout version")
+
+parser.add_option("-t", "--accept-buildout-test-releases",
+ dest='accept_buildout_test_releases',
+ action="store_true", default=False,
+ help=("Normally, if you do not specify a --version, the "
+ "bootstrap script and buildout gets the newest "
+ "*final* versions of zc.buildout and its recipes and "
+ "extensions for you. If you use this flag, "
+ "bootstrap and buildout will get the newest releases "
+ "even if they are alphas or betas."))
+parser.add_option("-c", "--config-file",
+ help=("Specify the path to the buildout configuration "
+ "file to be used."))
+parser.add_option("-f", "--find-links",
+ help=("Specify a URL to search for buildout releases"))
+parser.add_option("--allow-site-packages",
+ action="store_true", default=False,
+ help=("Let bootstrap.py use existing site packages"))
+parser.add_option("--setuptools-version", help="use a specific setuptools version")
+
+
+options, args = parser.parse_args()
+
+######################################################################
+# load/install setuptools
+
+try:
+ if options.allow_site_packages:
+ import setuptools
+ import pkg_resources
+ from urllib.request import urlopen
+except ImportError:
+ from urllib2 import urlopen
+
+ez = {}
+exec(urlopen('https://bootstrap.pypa.io/ez_setup.py').read(), ez)
+
+if not options.allow_site_packages:
+ # ez_setup imports site, which adds site packages
+ # this will remove them from the path to ensure that incompatible versions
+ # of setuptools are not in the path
+ import site
+ # inside a virtualenv, there is no 'getsitepackages'.
+ # We can't remove these reliably
+ if hasattr(site, 'getsitepackages'):
+ for sitepackage_path in site.getsitepackages():
+ sys.path[:] = [x for x in sys.path if sitepackage_path not in x]
+
+setup_args = dict(to_dir=tmpeggs, download_delay=0)
+
+if options.setuptools_version is not None:
+ setup_args['version'] = options.setuptools_version
+
+ez['use_setuptools'](**setup_args)
+import setuptools
+import pkg_resources
+
+# This does not (always?) update the default working set. We will
+# do it.
+for path in sys.path:
+ if path not in pkg_resources.working_set.entries:
+ pkg_resources.working_set.add_entry(path)
+
+######################################################################
+# Install buildout
+
+ws = pkg_resources.working_set
+
+cmd = [sys.executable, '-c',
+ 'from setuptools.command.easy_install import main; main()',
+ '-mZqNxd', tmpeggs]
+
+find_links = os.environ.get(
+ 'bootstrap-testing-find-links',
+ options.find_links or
+ ('http://downloads.buildout.org/'
+ if options.accept_buildout_test_releases else None)
+ )
+if find_links:
+ cmd.extend(['-f', find_links])
+
+setuptools_path = ws.find(
+ pkg_resources.Requirement.parse('setuptools')).location
+
+requirement = 'zc.buildout'
+version = options.version
+if version is None and not options.accept_buildout_test_releases:
+ # Figure out the most recent final version of zc.buildout.
+ import setuptools.package_index
+ _final_parts = '*final-', '*final'
+
+ def _final_version(parsed_version):
+ for part in parsed_version:
+ if (part[:1] == '*') and (part not in _final_parts):
+ return False
+ return True
+ index = setuptools.package_index.PackageIndex(
+ search_path=[setuptools_path])
+ if find_links:
+ index.add_find_links((find_links,))
+ req = pkg_resources.Requirement.parse(requirement)
+ if index.obtain(req) is not None:
+ best = []
+ bestv = None
+ for dist in index[req.project_name]:
+ distv = dist.parsed_version
+ if _final_version(distv):
+ if bestv is None or distv > bestv:
+ best = [dist]
+ bestv = distv
+ elif distv == bestv:
+ best.append(dist)
+ if best:
+ best.sort()
+ version = best[-1].version
+if version:
+ requirement = '=='.join((requirement, version))
+cmd.append(requirement)
+
+import subprocess
+if subprocess.call(cmd, env=dict(os.environ, PYTHONPATH=setuptools_path)) != 0:
+ raise Exception(
+ "Failed to execute command:\n%s" % repr(cmd)[1:-1])
+
+######################################################################
+# Import and run buildout
+
+ws.add_entry(tmpeggs)
+ws.require(requirement)
+import zc.buildout.buildout
+
+if not [a for a in args if '=' not in a]:
+ args.append('bootstrap')
+
+# if -c was provided, we push it back into args for buildout' main function
+if options.config_file is not None:
+ args[0:0] = ['-c', options.config_file]
+
+zc.buildout.buildout.main(args)
+shutil.rmtree(tmpeggs)
diff --git a/buildout.cfg b/buildout.cfg
new file mode 100644
index 0000000..45db0d1
--- /dev/null
+++ b/buildout.cfg
@@ -0,0 +1,20 @@
+[buildout]
+newest = false
+extensions = gp.vcsdevelop
+#vcs-extends-develop =
+parts = eggs
+develop = .
+
+[eggs]
+recipe = zc.recipe.egg
+eggs =
+ Sphinx
+ panoramisk
+interpreter = py
+
+[tests]
+recipe = zc.recipe.egg
+eggs =
+ panoramisk[test]
+dependent-scripts = true
+scripts = nosetests
diff --git a/docs/Makefile b/docs/Makefile
new file mode 100644
index 0000000..6264985
--- /dev/null
+++ b/docs/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) .
+# 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/panoramisk.qhcp"
+ @echo "To view the help file:"
+ @echo "# assistant -collectionFile $(BUILDDIR)/qthelp/panoramisk.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/panoramisk"
+ @echo "# ln -s $(BUILDDIR)/devhelp $$HOME/.local/share/devhelp/panoramisk"
+ @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."
diff --git a/docs/actions.rst b/docs/actions.rst
new file mode 100644
index 0000000..8a826c8
--- /dev/null
+++ b/docs/actions.rst
@@ -0,0 +1,12 @@
+=========================
+:mod:`panoramisk.actions`
+=========================
+
+.. automodule:: panoramisk.actions
+
+.. autoclass:: Action
+ :members:
+
+.. autoclass:: Command
+ :members:
+
diff --git a/docs/conf.py b/docs/conf.py
new file mode 100755
index 0000000..c56f8ca
--- /dev/null
+++ b/docs/conf.py
@@ -0,0 +1,247 @@
+# -*- coding: utf-8 -*-
+#
+# panoramisk documentation build configuration file, created by
+# sphinx-quickstart on Thu Jan 9 12:06:32 2014.
+#
+# 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, 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.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'panoramisk'
+copyright = u'2014, Gael Pasgrimaud'
+
+# 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 = ''
+# The full version, including alpha/beta/rc tags.
+release = ''
+
+# 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 = []
+
+
+# -- 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
+# "<project> v<release> 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']
+
+# 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 <link> 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 = 'panoramiskdoc'
+
+
+# -- 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]).
+latex_documents = [
+ ('index', 'panoramisk.tex', u'panoramisk Documentation',
+ u'Gael Pasgrimaud', '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', 'panoramisk', u'panoramisk Documentation',
+ [u'Gael Pasgrimaud'], 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', 'panoramisk', u'panoramisk Documentation',
+ u'Gael Pasgrimaud', 'panoramisk', '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'
+
+html_theme = 'nature'
+import pkg_resources
+version = pkg_resources.get_distribution("panoramisk").version
+release = version
diff --git a/docs/conftest.py b/docs/conftest.py
new file mode 100644
index 0000000..debe443
--- /dev/null
+++ b/docs/conftest.py
... 10759 lines suppressed ...
--
Alioth's /usr/local/bin/git-commit-notice on /srv/git.debian.org/git/python-modules/packages/panoramisk.git
More information about the Python-modules-commits
mailing list