splunk · madhadron · Nov 6, 2012 · Nov 3, 2012 · Nov 5, 2012 · Nov 5, 2012
diff --git a/.gitignore b/.gitignore
@@ -11,3 +11,4 @@ build/
 proxypid
 proxy.log
 MANIFEST
+coverage_report
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -2,6 +2,7 @@
 
 ## 1.0
 
+* Stanza.submit now takes a dictionary of key/value pairs specifying the stanza instead of a raw string.
 * Namespace handling has changed subtly. Code that depends on namespace handling in detail may break.
 * Added User.role_entities to return a list of the actual entity objects for the
   roles of a user. User.roles still returns a list of the role names.

diff --git a/docs/CSS/splunk_customizations.css b/docs/CSS/splunk_customizations.css
@@ -0,0 +1,2 @@
+a.headerlink { display: none; }
+
diff --git a/docs/Makefile b/docs/Makefile
@@ -43,16 +43,19 @@ clean:
 
 html:
 	$(SPHINXBUILD) -b html $(ALLSPHINXOPTS) $(BUILDDIR)/html
+	sh munge_links.sh $(BUILDDIR)/html
 	@echo
 	@echo "Build finished. The HTML pages are in $(BUILDDIR)/html."
 
 dirhtml:
 	$(SPHINXBUILD) -b dirhtml $(ALLSPHINXOPTS) $(BUILDDIR)/dirhtml
+	sh munge_links.sh $(BUILDDIR)/dirhtml
 	@echo
 	@echo "Build finished. The HTML pages are in $(BUILDDIR)/dirhtml."
 
 singlehtml:
 	$(SPHINXBUILD) -b singlehtml $(ALLSPHINXOPTS) $(BUILDDIR)/singlehtml
+	sh munge_links.sh $(BUILDDIR)/singlehtml
 	@echo
 	@echo "Build finished. The HTML page is in $(BUILDDIR)/singlehtml."
 

diff --git a/docs/_templates/layout.html b/docs/_templates/layout.html
@@ -0,0 +1,5 @@
+{% extends '!layout.html' %}
+
+{% set css_files = css_files + ["_static/splunk_customizations.css"] %}
+
+{% set reldelim2 = "" %}
diff --git a/docs/binding.rst b/docs/binding.rst
@@ -3,30 +3,30 @@ splunklib.binding
 
 .. automodule:: splunklib.binding
 
-.. autoclass:: Context
-    :members: connect, delete, get, login, logout, post, request
-
 .. autofunction:: connect
 
+.. autofunction:: handler
+
 .. autofunction:: namespace
 
-.. autoclass:: UrlEncoded
+.. autoclass:: AuthenticationError
     :members:
 
-.. autoclass:: ResponseReader
-    :members: close, empty, peek, read
+.. autoclass:: Context
+    :members: connect, delete, get, login, logout, post, request
 
 .. autoclass:: HTTPError
     :members:
 
 .. autoclass:: HttpLib
     :members: delete, get, post, request
 
-.. autofunction:: handler
-
-.. autoclass:: AuthenticationError
+.. autoclass:: NoAuthenticationToken
     :members:
 
-.. autoclass:: NoAuthenticationToken
+.. autoclass:: ResponseReader
+    :members: close, empty, peek, read
+
+.. autoclass:: UrlEncoded
     :members:
 
diff --git a/docs/client.rst b/docs/client.rst
@@ -5,20 +5,15 @@ splunklib.client
 
 .. autofunction:: connect
 
-.. autoclass:: Service
-    :members: apps, confs, capabilities, event_types, fired_alerts, indexes, info, inputs, jobs, loggers, messages, modular_input_kinds, parse, restart, restart_required, roles, search, saved_searches, settings, splunk_version, users
-    :inherited-members:
-
-.. autoclass:: Endpoint
-    :members: get, post
-    :inherited-members:
+.. autoclass:: AmbiguousReferenceException
+    :members:
 
-.. autoclass:: Entity
-    :members: delete, get, post, refresh, access, disable, enable, fields, links, name, namespace, reload, update
+.. autoclass:: Application
+    :members: setupInfo, package, updateInfo
     :inherited-members:
 
-.. autoclass:: ReadOnlyCollection
-    :members: itemmeta, iter, list, names
+.. autoclass:: AlertGroup
+    :members: alerts, count
     :inherited-members:
 
 .. autoclass:: Collection
@@ -32,22 +27,31 @@ splunklib.client
     :members: create, delete
     :inherited-members:
 
-.. autoclass:: Stanza
-    :members: submit
+.. autoclass:: Endpoint
+    :members: get, post
     :inherited-members:
 
-.. autoclass:: AlertGroup
-    :members: alerts, count
+.. autoclass:: Entity
+    :members: access, delete, disable, enable, fields, get, links, name, namespace, post, refresh, reload, update
     :inherited-members:
 
-.. autoclass:: Indexes
-    :members: default, delete
-    :inherited-members:
+.. autoclass:: EntityDeletedException
+    :members:
+
+.. autoclass:: IllegalOperationException
+    :members:
+
+.. autoclass:: IncomparableException
+    :members:
 
 .. autoclass:: Index
     :members: attach, attached_socket, clean, disable, enable, roll_hot_buckets, submit, upload
     :inherited-members:
 
+.. autoclass:: Indexes
+    :members: default, delete
+    :inherited-members:
+
 .. autoclass:: Input
     :members: update
     :inherited-members:
@@ -56,10 +60,16 @@ splunklib.client
     :members: create, delete, itemmeta, kinds, kindpath, list, iter, oneshot
     :inherited-members:
 
+.. autoclass:: InvalidNameException
+    :members:
+
 .. autoclass:: Job
     :members: cancel, disable_preview, enable_preview, events, finalize, is_done, is_ready, name, pause, refresh, results, preview, searchlog, set_priority, summary, timeline, touch, set_ttl, unpause
     :inherited-members:
 
+.. autoclass:: JobNotReadyException
+    :members:
+
 .. autoclass:: Jobs
     :members: create, export, itemmeta, oneshot
     :inherited-members:
@@ -76,24 +86,26 @@ splunklib.client
     :members: arguments, update
     :inherited-members:
 
-.. autoclass:: SavedSearch
-    :members: acknowledge, alert_count, dispatch, fired_alerts, history, update, scheduled_times, suppress, suppressed, unsuppress
-    :inherited-members:
+.. autoclass:: NoSuchApplicationException
+    :members:
 
-.. autoclass:: SavedSearches
-    :members: create
-    :inherited-members:
+.. autoclass:: NoSuchCapability
+    :members:
 
-.. autoclass:: Settings
-    :members: update
-    :inherited-members:
+.. autoclass:: NoSuchUserException
+    :members:
 
-.. autoclass:: User
-    :members: role_entities
-    :inherited-members:
+.. autoclass:: NotSupportedError
+    :members:
 
-.. autoclass:: Users
-    :members: create, delete
+.. autoclass:: OperationError
+    :members:
+
+.. autoclass:: OperationFailedException
+    :members:
+
+.. autoclass:: ReadOnlyCollection
+    :members: itemmeta, iter, list, names
     :inherited-members:
 
 .. autoclass:: Role
@@ -104,42 +116,30 @@ splunklib.client
     :members: create, delete
     :inherited-members:
 
-.. autoclass:: Application
-    :members: setupInfo, package, updateInfo
+.. autoclass:: SavedSearch
+    :members: acknowledge, alert_count, dispatch, fired_alerts, history, scheduled_times, suppress, suppressed, unsuppress, update
     :inherited-members:
 
-.. autoclass:: NoSuchUserException
-    :members:
-
-.. autoclass:: NoSuchApplicationException
-    :members:
-
-.. autoclass:: IllegalOperationException
-    :members:
-
-.. autoclass:: IncomparableException
-    :members:
-
-.. autoclass:: JobNotReadyException
-    :members:
-
-.. autoclass:: AmbiguousReferenceException
-    :members:
-
-.. autoclass:: EntityDeletedException
-    :members:
+.. autoclass:: SavedSearches
+    :members: create
+    :inherited-members:
 
-.. autoclass:: InvalidNameException
-    :members:
+.. autoclass:: Service
+    :members: apps, confs, capabilities, event_types, fired_alerts, indexes, info, inputs, jobs, loggers, messages, modular_input_kinds, parse, restart, restart_required, roles, search, saved_searches, settings, splunk_version, users
+    :inherited-members:
 
-.. autoclass:: OperationFailedException
-    :members:
+.. autoclass:: Settings
+    :members: update
+    :inherited-members:
 
-.. autoclass:: NoSuchCapability
-    :members:
+.. autoclass:: Stanza
+    :members: submit
+    :inherited-members:
 
-.. autoclass:: OperationError
-    :members:
+.. autoclass:: User
+    :members: role_entities
+    :inherited-members:
 
-.. autoclass:: NotSupportedError
-    :members:
+.. autoclass:: Users
+    :members: create, delete
+    :inherited-members:
diff --git a/docs/data.rst b/docs/data.rst
@@ -5,8 +5,8 @@ splunklib.data
 
 .. autofunction:: load
 
+.. autofunction:: record
+
 .. autoclass:: Record
     :members: 
 
-.. autofunction:: record
-
diff --git a/docs/index.rst b/docs/index.rst
@@ -17,6 +17,7 @@ For more information about the SDK, see the `Splunk Developer Portal <http://dev
 
     :class:`~splunklib.binding.UrlEncoded` class
 
+
     **Exceptions**
 
     :func:`~splunklib.binding.handler` function
@@ -41,16 +42,23 @@ For more information about the SDK, see the `Splunk Developer Portal <http://dev
 
     :class:`~splunklib.client.Endpoint` base class 
 
+
     **Entities and collections**
 
-    :class:`~splunklib.client.AlertGroup` class
+    :class:`~splunklib.client.Entity` class
+
+    :class:`~splunklib.client.Collection` class
+
+    :class:`~splunklib.client.ReadOnlyCollection` class
 
     :class:`~splunklib.client.Application` class
 
-    :class:`~splunklib.client.Collection` class
+    :class:`~splunklib.client.AlertGroup` class
 
     :class:`~splunklib.client.ConfigurationFile` class
 
+    :class:`~splunklib.client.Stanza` class
+
     :class:`~splunklib.client.Configurations` class
 
     :class:`~splunklib.client.Index` class
@@ -71,8 +79,6 @@ For more information about the SDK, see the `Splunk Developer Portal <http://dev
 
     :class:`~splunklib.client.ModularInputKind` class
 
-    :class:`~splunklib.client.ReadOnlyCollection` class
-
     :class:`~splunklib.client.Role` class
 
     :class:`~splunklib.client.Roles` class
@@ -83,11 +89,10 @@ For more information about the SDK, see the `Splunk Developer Portal <http://dev
 
     :class:`~splunklib.client.Settings` class
 
-    :class:`~splunklib.client.Stanza` class
-
     :class:`~splunklib.client.User` class
 
     :class:`~splunklib.client.Users` class
+
 
     **Exceptions**
 

diff --git a/docs/munge_links.sh b/docs/munge_links.sh
@@ -0,0 +1,8 @@
+#!/bin/bash
+
+TARGET=$1
+
+for file in $TARGET/*.html; do
+    echo ${file}
+    sed -i -e 's/class="reference external"/class="reference external" target="_blank"/g' "${file}"
+done
diff --git a/docs/results.rst b/docs/results.rst
@@ -3,6 +3,6 @@ splunklib.results
 
 .. automodule:: splunklib.results
 
-.. autoclass:: ResultsReader
-
 .. autoclass:: Message
+
+.. autoclass:: ResultsReader