python3 last change

Update Manager.py added EarlyMedia to originate

.gitignore

@@ -5,6 +5,7 @@
 .coverage
 
 # Build remnants.
+html
 dist
 build
 _build

CHANGELOG

@@ -1,3 +1,28 @@
+2016-11-04  VoiPCS <https://github.com/VoIPCS>
+
+    * Fixing unicode bug in `send_action` for AMI.
+
+2016-02-16  Randall Degges <https://github.com/rdegges>
+
+    * Fixing issue in AGI class init function. Thanks to @sancho2934489 for the
+      find!
+
+2015-11-16  Scinawa Antani <https://github.com/Scinawa>
+
+    * Fixing indentation errors.
+
+2015-11-14  Ben Davis <https://github.com/tuxpowered>
+
+    * Handling more UTF-8 encoding issues in `_quote` method.
+
+2015-07-18  Artem Sorokin
+
+    * Fixing UTF-8 encoding issues.
+
+2015-07-15  Artem Sorokin
+
+    * Fix multiline command end marker for OpenVox GSM Gateway.
+
 2015-03-31  Randall Degges
 
     * Porting packaging to setuptools (modern).

README.rst

@@ -89,6 +89,17 @@ directly on the host where Asterisk is running. Since Asterisk doesn't
 run on windows platforms (and probably never will) the agi part of the
 package can only be run on Asterisk platforms.
 
+FastAGI
+-------
+
+FastAGI support is a python based raw SocketServer, To start the server
+python fastagi.py should start it listening on localhost and the default
+asterisk FastAGI port. This does require the newest version of pyst2.
+The FastAGI server runs in as a Forked operation for each request, in
+an attempt to prevent blocking by a single bad service. As a result the
+FastAGI server may consume more memory then a single process. If you need
+to use a single process simply uncomment the appropriate line. Future versions
+of this will use a config file to set options.
 
 Credits
 -------

asterisk/__init__.py

@@ -11,4 +11,4 @@ manager - a module for interacting with the asterisk manager interface
 """
 
 __all__ = ['agi', 'agitb', 'config', 'manager']
-__version__ = '0.4.4'
+__version__ = '0.5.0'

asterisk/agi.py

@@ -1,28 +1,33 @@
-#!/usr/bin/env python2
+#! /usr/bin/env python
-# vim: set et sw=4:
+# -*- coding: utf-8 -*-
-"""agi
+# vim: set et sw=4 fenc=utf-8: 
-
+"""
-This module contains functions and classes to implment AGI scripts in python.
+.. module:: agi
+   :synopsis: This module contains functions and classes to implment AGI scripts in python. 
+   
 pyvr
 
 {'agi_callerid' : 'mars.putland.int',
  'agi_channel'  : 'IAX[kputland@kputland]/119',
  'agi_context'  : 'default',
- 'agi_dnid'     : '666',
+ 'agi_dnid'     : '1000',
  'agi_enhanced' : '0.0',
- 'agi_extension': '666',
+ 'agi_extension': '1000',
  'agi_language' : 'en',
  'agi_priority' : '1',
  'agi_rdnis'    : '',
  'agi_request'  : 'pyst',
  'agi_type'     : 'IAX'}
 
+Specification
+-------------
 """
 
 import sys
 import pprint
 import re
 import signal
+from six import PY3
 
 DEFAULT_TIMEOUT = 2000  # 2sec timeout used as default for functions that take timeouts
 DEFAULT_RECORD = 20000  # 20sec record time
@@ -77,7 +82,7 @@ class AGIUsageError(AGIError):
 class AGIInvalidCommand(AGIError):
     pass
 
-
+        
 class AGI:
     """
     This class encapsulates communication between Asterisk an a python script.
@@ -85,21 +90,26 @@ class AGI:
     Asterisk.
     """
 
-    def __init__(self):
+    def __init__(self, stdin=sys.stdin, stdout=sys.stdout, stderr=sys.stderr):
+        self.stdin = stdin
+        self.stdout = stdout
+        self.stderr = stderr
         self._got_sighup = False
         signal.signal(signal.SIGHUP, self._handle_sighup)  # handle SIGHUP
-        sys.stderr.write('ARGS: ')
+        self.stderr.write('ARGS: ')
-        sys.stderr.write(str(sys.argv))
+        self.stderr.write(str(sys.argv))
-        sys.stderr.write('\n')
+        self.stderr.write('\n')
         self.env = {}
         self._get_agi_env()
 
     def _get_agi_env(self):
         while 1:
-            line = sys.stdin.readline().strip()
+            line = self.stdin.readline().strip()
-            sys.stderr.write('ENV LINE: ')
+            if PY3:
-            sys.stderr.write(line)
+                if type(line) is bytes: line = line.decode('utf8')
-            sys.stderr.write('\n')
+            self.stderr.write('ENV LINE: ')
+            self.stderr.write(line)
+            self.stderr.write('\n')
             if line == '':
                 #blank line signals end
                 break
@@ -108,12 +118,20 @@ class AGI:
             data = data.strip()
             if key != '':
                 self.env[key] = data
-        sys.stderr.write('class AGI: self.env = ')
+        self.stderr.write('class AGI: self.env = ')
-        sys.stderr.write(pprint.pformat(self.env))
+        self.stderr.write(pprint.pformat(self.env))
-        sys.stderr.write('\n')
+        self.stderr.write('\n')
 
     def _quote(self, string):
-        return ''.join(['"', str(string), '"'])
+        """ provides double quotes to string, converts int/bool to string """
+        if isinstance(string, int):
+          string = str(string)
+        if isinstance(string, float):
+          string = str(string)
+        if PY3:
+            return ''.join(['"', string, '"'])
+        else:
+            return ''.join(['"', string.encode('utf8', 'ignore'), '"'])
 
     def _handle_sighup(self, signum, frame):
         """Handle the SIGHUP signal"""
@@ -144,16 +162,21 @@ class AGI:
         command = command.strip()
         if command[-1] != '\n':
             command += '\n'
-        sys.stderr.write('    COMMAND: %s' % command)
+        self.stderr.write('    COMMAND: %s' % command)
-        sys.stdout.write(command)
+        if PY3:
-        sys.stdout.flush()
+            self.stdout.write(command.encode('utf8'))
+        else:
+            self.stdout.write(command)
+        self.stdout.flush()
 
     def get_result(self, stdin=sys.stdin):
         """Read the result of a command from Asterisk"""
         code = 0
         result = {'result': ('', '')}
-        line = stdin.readline().strip()
+        line = self.stdin.readline().strip()
-        sys.stderr.write('    RESULT_LINE: %s\n' % line)
+        if PY3:
+            if type(line) is bytes: line = line.decode('utf8')
+        self.stderr.write('    RESULT_LINE: %s\n' % line)
         m = re_code.search(line)
         if m:
             code, response = m.groups()
@@ -170,16 +193,20 @@ class AGI:
                 if key == 'result' and value == '-1':
                     raise AGIAppError("Error executing application, or hangup")
 
-            sys.stderr.write('    RESULT_DICT: %s\n' % pprint.pformat(result))
+            self.stderr.write('    RESULT_DICT: %s\n' % pprint.pformat(result))
             return result
         elif code == 510:
             raise AGIInvalidCommand(response)
         elif code == 520:
             usage = [line]
-            line = stdin.readline().strip()
+            line = self.stdin.readline().strip()
+            if PY3:
+                if type(line) is bytes: line = line.decode('utf8')
             while line[:3] != '520':
                 usage.append(line)
-                line = stdin.readline().strip()
+                line = self.stdin.readline().strip()
+                if PY3:
+                    if type(line) is bytes: line = line.decode('utf8')
             usage.append(line)
             usage = '%s\n' % '\n'.join(usage)
             raise AGIUsageError(usage)
@@ -482,17 +509,20 @@ class AGI:
         self.set_extension(extension)
         self.set_priority(priority)
 
-    def record_file(self, filename, format='gsm', escape_digits='#', timeout=DEFAULT_RECORD, offset=0, beep='beep'):
+    def record_file(self, filename, format='gsm', escape_digits='#', timeout=DEFAULT_RECORD, offset=0, beep='beep', silence=0):
-        """agi.record_file(filename, format, escape_digits, timeout=DEFAULT_TIMEOUT, offset=0, beep='beep') --> None
+        """agi.record_file(filename, format, escape_digits, timeout=DEFAULT_TIMEOUT, offset=0, beep='beep', silence=0) --> None
-        Record to a file until a given dtmf digit in the sequence is received
+        Record to a file until a given dtmf digit in the sequence is received. Returns
-        The format will specify what kind of file will be recorded.  The timeout
+        '-1' on hangup or error.  The format will specify what kind of file will be
-        is the maximum record time in milliseconds, or -1 for no timeout. Offset
+        recorded. The <timeout> is the maximum record time in milliseconds, or '-1'
-        samples is optional, and if provided will seek to the offset without
+        for no <timeout>. <offset samples> is optional, and, if provided, will seek
-        exceeding the end of the file
+        to the offset without exceeding the end of the file. <silence> is the number
+        of seconds of silence allowed before the function returns despite the lack
+        of dtmf digits or reaching <timeout>. <silence> value must be preceded by
+        's=' and is also optional.
         """
         escape_digits = self._process_digit_list(escape_digits)
         res = self.execute('RECORD FILE', self._quote(filename), format,
-                           escape_digits, timeout, offset, beep)['result'][0]
+                           escape_digits, timeout, offset, beep, ('s=%s' % silence))['result'][0]
         try:
             return chr(int(res))
         except:
@@ -659,6 +689,13 @@ class AGI:
         """
         self.execute('NOOP')
 
+    def exec_command(self, command, *args):
+        """Send an arbitrary asterisk command with args (even not AGI commands)"""
+        # The arguments of the command should be prepared as comma delimited, that's the way the EXEC works
+        args = ','.join(map(str, args))
+        return self.execute('EXEC', command, args)
+
+
 if __name__ == '__main__':
     agi = AGI()
     #agi.appexec('festival','Welcome to Klass Technologies.  Thank you for calling.')

asterisk/agitb.py

@@ -1,20 +1,27 @@
-"""More comprehensive traceback formatting for Python scripts.
+"""
+.. module:: agitb
+   :synopsis: More comprehensive traceback formatting for Python scripts.
+
+Example
+-------
 
 To enable this module, do:
 
-    import asterisk.agitb, asterisk.agi
+.. code-block:: python
-    asterisk.agitb.enable(display = False, logdir = '/var/log/asterisk/')
 
-    agi = asterisk.agi.AGI()
+   import asterisk.agitb, asterisk.agi
-    asterisk.agitb.enable(agi, False, '/var/log/asterisk')
+   asterisk.agitb.enable(display = False, logdir = '/var/log/asterisk/')
+
+   agi = asterisk.agi.AGI()
+   asterisk.agitb.enable(agi, False, '/var/log/asterisk')
 
 at the top of your script.  The optional arguments to enable() are:
 
-    agi         - the agi handle to write verbose messages to
+* agi         - the agi handle to write verbose messages to
-    display     - if true, tracebacks are displayed on the asterisk console
+* display     - if true, tracebacks are displayed on the asterisk console
-                  (used with the agi option)
+  (used with the agi option)
-    logdir      - if set, tracebacks are written to files in this directory
+* logdir      - if set, tracebacks are written to files in this directory
-    context     - number of lines of source code to show for each stack frame
+* context     - number of lines of source code to show for each stack frame
 
 By default, tracebacks are displayed but not saved, and the context is 5 lines.
 
@@ -27,6 +34,9 @@ for you, call agitb.handler().  The optional argument to handler() is a
 If you do not pass anything to handler() it will use sys.exc_info().
 
 This script was adapted from Ka-Ping Yee's cgitb.
+
+Specification
+-------------
 """
 
 __author__ = 'Matthew Nicholson'

asterisk/config.py

@@ -1,13 +1,19 @@
 #!/usr/bin/env python
 # vim: set expandtab:
 """
-Parse Asterisk configuration files.
+.. module:: config
+   :synopsis: Parse Asterisk configuration files.
 
 This module provides parsing functionality for asterisk config files.
 
+Example
+----------
+
+.. code-block:: python
+
    import asterisk.config
    import sys
-
+   
    # load and parse the config file
    try:
       config = asterisk.config.Config('/etc/asterisk/extensions.conf')
@@ -17,13 +23,17 @@ This module provides parsing functionality for asterisk config files.
    except IOError as e:
       print "Error opening file: %s" % e.strerror
       sys.exit(1)
-
+   
    # print our parsed output
    for category in config.categories:
       print '[%s]' % category.name   # print the current category
 
       for item in category.items:
          print '   %s = %s' % (item.name, item.value)
+
+
+Specification
+-------------
 """
 
 import sys

asterisk/fastagi.py

@@ -0,0 +1,48 @@
+#!/usr/bin/env python
+
+"""
+.. module:: fastagi
+   :synopsis: FastAGI service for Asterisk
+
+Requires modified pyst2 to support reading stdin/out/err
+ 
+ Copyright 2011 VOICE1, LLC
+ By: Ben Davis <ben@voice1-dot-me>
+
+Specification
+-------------
+"""
+
+import sys
+import SocketServer
+import asterisk.agi
+# import pkg_resources
+# PYST_VERSION = pkg_resources.get_distribution("pyst2").version
+
+__verison__ = 0.1
+
+#TODO: Read options from config file.
+HOST, PORT = "127.0.0.1", 4573
+
+class FastAGI(SocketServer.StreamRequestHandler):
+    # Close connections not finished in 5seconds.
+    timeout = 5
+    def handle(self):
+        try:
+            agi=asterisk.agi.AGI(stdin=self.rfile, stdout=self.wfile, stderr=sys.stderr)
+            agi.verbose("pyst2: FastAGI on: {}:{}".format(HOST, PORT))
+        except TypeError as e:
+            sys.stderr.write('Unable to connect to agi://{} {}\n'.format(self.client_address[0], str(e)))
+        except SocketServer.socket.timeout as e:
+            sys.stderr.write('Timeout receiving data from {}\n'.format(self.client_address))
+        except SocketServer.socket.error as e:
+            sys.stderr.write('Could not open the socket. Is someting else listening on this port?\n')
+        except Exception as e:
+            sys.stderr.write('An unknown error: {}\n'.format(str(e)))
+
+if __name__ == "__main__":
+    # server = SocketServer.TCPServer((HOST, PORT), FastAGI)
+    server = SocketServer.ForkingTCPServer((HOST, PORT), FastAGI)
+
+    # Keep server running until CTRL-C is pressed.
+    server.serve_forever()

asterisk/manager.py

@@ -2,10 +2,16 @@
 # vim: set expandtab shiftwidth=4:
 
 """
-Python Interface for Asterisk Manager
+.. module:: manager
+   :synopsis: Python Interface for Asterisk Manager
 
 This module provides a Python API for interfacing with the asterisk manager.
 
+Example
+-------
+
+.. code-block:: python
+
    import asterisk.manager
    import sys
 
@@ -50,6 +56,9 @@ Remember all header, response, and event names are case sensitive.
 
 Not all manager actions are implmented as of yet, feel free to add them
 and submit patches.
+
+Specification
+-------------
 """
 
 import sys
@@ -108,7 +117,15 @@ class ManagerMsg(object):
                 break
             try:
                 k, v = (x.strip() for x in line.split(':', 1))
-                self.headers[k] = v
+                # if header is ChanVariable it can have more that one value
+                # we store the variable in a dictionary parsed
+                if 'ChanVariable' in k:
+                    if not self.headers.has_key('ChanVariable'):
+                        self.headers['ChanVariable']={}
+                    name, value = (x.strip() for x in v.split('=',1))
+                    self.headers['ChanVariable'][name]=value
+                else:
+                    self.headers[k] = v
             except ValueError:
                 # invalid header, start of multi-line data response
                 data.extend(response[n:])
@@ -263,7 +280,7 @@ class Manager(object):
 
         # lock the socket and send our command
         try:
-            self._sock.write(command.encode('ascii'))
+            self._sock.write(command.encode('utf8','ignore'))
             self._sock.flush()
         except socket.error as e:
             raise ManagerSocketException(e.errno, e.strerror)
@@ -291,7 +308,7 @@ class Manager(object):
             try:
                 lines = []
                 for line in self._sock:
-                    line = line.decode('ascii')
+                    line = line.decode('utf8','ignore')
                     # check to see if this is the greeting line
                     if not self.title and '/' in line and not ':' in line:
                         # store the title of the manager we are connecting to:
@@ -331,7 +348,7 @@ class Manager(object):
                             line.split(':', 1)[1].strip() == 'Follows':
                         wait_for_marker = True
                     # same when seeing end of multiline response
-                    if multiline and line.startswith('--END COMMAND--'):
+                    if multiline and (line.startswith('--END COMMAND--') or line.strip().endswith('--END COMMAND--')):
                         wait_for_marker = False
                         multiline = False
                     # same when seeing end of status response
@@ -558,7 +575,7 @@ class Manager(object):
 
         return response
 
-    def originate(self, channel, exten, context='', priority='', timeout='', caller_id='', async=False, account='', variables={}):
+    def originate(self, channel, exten, context='', priority='', timeout='', caller_id='', async=False, earlymedia='false', account='', variables={}):
         """Originate a call"""
 
         cdict = {'Action': 'Originate'}
@@ -574,6 +591,8 @@ class Manager(object):
             cdict['CallerID'] = caller_id
         if async:
             cdict['Async'] = 'yes'
+        if earlymedia:
+            cdict['EarlyMedia'] = earlymedia
         if account:
             cdict['Account'] = account
         # join dict of vairables together in a string in the form of 'key=val|key=val'

docs/Makefile

@@ -0,0 +1,216 @@
+# Makefile for Sphinx documentation
+#
+
+# You can set these variables from the command line.
+SPHINXOPTS    =
+SPHINXBUILD   = sphinx-build
+PAPER         =
+BUILDDIR      = ../
+
+# 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) source
+# the i18n builder cannot share the environment and doctrees with the others
+I18NSPHINXOPTS  = $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) source
+
+.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 "  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)"
+
+.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/pyst2.qhcp"
+	@echo "To view the help file:"
+	@echo "# assistant -collectionFile $(BUILDDIR)/qthelp/pyst2.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/pyst2"
+	@echo "# ln -s $(BUILDDIR)/devhelp $$HOME/.local/share/devhelp/pyst2"
+	@echo "# devhelp"
+
+.PHONY: epub
+epub:
+	$(SPHINXBUILD) -b epub $(ALLSPHINXOPTS) $(BUILDDIR)/epub
+	@echo
+	@echo "Build finished. The epub file is in $(BUILDDIR)/epub."
+
+.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: 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."

docs/source/agi.rst

@@ -0,0 +1,6 @@
+AGI
+=========================
+
+.. automodule:: asterisk.agi
+   :members:
+

docs/source/agitb.rst

@@ -0,0 +1,6 @@
+AGITB
+=========================
+
+.. automodule:: asterisk.agitb
+   :members:
+

docs/source/changes.rst

@@ -0,0 +1,5 @@
+Changes
+*******
+
+.. include:: ../../CHANGELOG
+

docs/source/conf.py

@@ -0,0 +1,294 @@
+# -*- coding: utf-8 -*-
+#
+# pyst2 documentation build configuration file, created by
+# sphinx-quickstart on Mon Mar  7 10:41:33 2016.
+#
+# 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.intersphinx',
+    'sphinx.ext.todo',
+    'sphinx.ext.coverage',
+    'sphinx.ext.ifconfig',
+    'sphinx.ext.viewcode',
+]
+
+# Add any paths that contain templates here, relative to this directory.
+templates_path = ['_templates']
+
+# The suffix(es) of source filenames.
+# You can specify multiple suffix as a list of string:
+# source_suffix = ['.rst', '.md']
+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'pyst2'
+copyright = u'2016, Randall Degges'
+author = u'Randall Degges'
+
+# 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 = u'0.4.9'
+# The full version, including alpha/beta/rc tags.
+release = u'0.4.9'
+
+# The language for content autogenerated by Sphinx. Refer to documentation
+# for a list of supported languages.
+#
+# This is also used if you do content translation via gettext catalogs.
+# Usually you set "language" from the command line for these cases.
+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 = []
+
+# 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
+
+# If true, `todo` and `todoList` produce output, else they produce nothing.
+todo_include_todos = True
+
+
+# -- 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 = 'alabaster'
+
+# 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 (relative to this directory) to use as a 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 <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
+
+# Language to be used for generating the HTML full-text search index.
+# Sphinx supports the following languages:
+#   'da', 'de', 'en', 'es', 'fi', 'fr', 'hu', 'it', 'ja'
+#   'nl', 'no', 'pt', 'ro', 'ru', 'sv', 'tr'
+#html_search_language = 'en'
+
+# A dictionary with options for the search language support, empty by default.
+# Now only 'ja' uses this config value
+#html_search_options = {'type': 'default'}
+
+# The name of a javascript file (relative to the configuration directory) that
+# implements a search results scorer. If empty, the default will be used.
+#html_search_scorer = 'scorer.js'
+
+# Output file base name for HTML help builder.
+htmlhelp_basename = 'pyst2doc'
+
+# -- 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': '',
+
+# Latex figure (float) alignment
+#'figure_align': 'htbp',
+}
+
+# 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 = [
+    (master_doc, 'pyst2.tex', u'pyst2 Documentation',
+     u'Randall Degges', '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 = [
+    (master_doc, 'pyst2', u'pyst2 Documentation',
+     [author], 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 = [
+    (master_doc, 'pyst2', u'pyst2 Documentation',
+     author, 'pyst2', '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
+
+
+# Example configuration for intersphinx: refer to the Python standard library.
+intersphinx_mapping = {'https://docs.python.org/': None}

docs/source/config.rst

@@ -0,0 +1,6 @@
+Config
+=========================
+
+.. automodule:: asterisk.config
+   :members:
+

docs/source/fastagi.rst

@@ -0,0 +1,6 @@
+fastAGI
+=========================
+
+.. automodule:: asterisk.fastagi
+   :members:
+

docs/source/index.rst

@@ -0,0 +1,29 @@
+.. pyst2 documentation master file, created by
+   sphinx-quickstart on Mon Mar  7 10:41:33 2016.
+   You can adapt this file completely to your liking, but it should at least
+   contain the root `toctree` directive.
+
+Welcome to pyst2's documentation!
+=================================
+
+Contents:
+
+.. toctree::
+   :maxdepth: 2
+
+   readme
+   agi
+   agitb
+   config
+   fastagi
+   manager
+
+   changes
+
+Indices and tables
+==================
+
+* :ref:`genindex`
+* :ref:`modindex`
+* :ref:`search`
+

docs/source/manager.rst

@@ -0,0 +1,6 @@
+Manager
+=========================
+
+.. automodule:: asterisk.manager
+   :members:
+

docs/source/readme.rst

@@ -0,0 +1 @@
+.. include:: ../../README.rst