Merge branch 'develop' into fross/fired-alert-tests

Author: Frederick Ross

docs/client.rst

@@ -30,12 +30,12 @@ splunklib.client
     :inherited-members:
     :undoc-members:
 
-.. autoclass:: Conf
+.. autoclass:: ConfigurationFile
     :members:
     :inherited-members:
     :undoc-members:
 
-.. autoclass:: Confs
+.. autoclass:: Configurations
     :members:
     :inherited-members:
     :undoc-members:
@@ -107,4 +107,4 @@ splunklib.client
 .. autoclass:: OperationError
     :members:
     :inherited-members:
-    :undoc-members:
+    :undoc-members:

docs/index.rst

@@ -31,46 +31,81 @@ For more information about the SDK, see the `Developer Portal <http://dev.splunk
 
     **Entities and collections**
 
-    :class:`~splunklib.client.Entity` base class 
+    :class:`~splunklib.client.AlertGroup` class
 
-    :class:`~splunklib.client.Collection` base class 
+    :class:`~splunklib.client.Application` class
 
-    :class:`~splunklib.client.AlertGroup` class 
+    :class:`~splunklib.client.Collection` class
 
-    :class:`~splunklib.client.Conf` class 
 
-    :class:`~splunklib.client.Confs` class 
+    :class:`~splunklib.client.ConfigurationFile` class
 
-    :class:`~splunklib.client.Stanza` class 
+    :class:`~splunklib.client.Configurations` class
 
-    :class:`~splunklib.client.Index` class 
+    :class:`~splunklib.client.Entity` class
 
-    :class:`~splunklib.client.Input` class 
+    :class:`~splunklib.client.Index` class
 
-    :class:`~splunklib.client.Inputs` class 
+    :class:`~splunklib.client.Indexes` class
 
-    :class:`~splunklib.client.Job` class 
+    :class:`~splunklib.client.Input` class
 
-    :class:`~splunklib.client.Jobs` class 
+    :class:`~splunklib.client.Inputs` class
 
-    :class:`~splunklib.client.Loggers` class 
+    :class:`~splunklib.client.Job` class
 
-    :class:`~splunklib.client.Message` class 
+    :class:`~splunklib.client.Jobs` class
 
-    :class:`~splunklib.client.SavedSearch` class 
+    :class:`~splunklib.client.Loggers` class
 
-    :class:`~splunklib.client.SavedSearches` class 
+    :class:`~splunklib.client.Message` class
 
-    :class:`~splunklib.client.Settings` class 
+    :class:`~splunklib.client.ModularInputKind` class
 
-    :class:`~splunklib.client.Users` class 
+    :class:`~splunklib.client.ReadOnlyCollection` class
+
+    :class:`~splunklib.client.Role` class
+
+    :class:`~splunklib.client.Roles` class
+
+    :class:`~splunklib.client.SavedSearch` class
+
+    :class:`~splunklib.client.SavedSearches` class
+
+    :class:`~splunklib.client.Settings` class
+
+    :class:`~splunklib.client.Stanza` class
+
+    :class:`~splunklib.client.User` class
+
+    :class:`~splunklib.client.Users` class
 
     **Exceptions**
 
-    :class:`~splunklib.client.NotSupportedError` class 
+    :class:`~splunklib.client.AmbiguousReferenceException` class
+
+    :class:`~splunklib.client.EntityDeletedException` class
+
+    :class:`~splunklib.client.IllegalOperationException` class
+
+    :class:`~splunklib.client.IncomparableException` class
+
+    :class:`~splunklib.client.InvalidNameException` class
+
+    :class:`~splunklib.client.JobNotReadyException` class
+
+    :class:`~splunklib.client.NoSuchApplicationException` class
+
+    :class:`~splunklib.client.NoSuchCapability` class
+
+    :class:`~splunklib.client.NoSuchUserException` class
+
+    :class:`~splunklib.client.NotSupportedError` class
 
-    :class:`~splunklib.client.OperationError` class 
+    :class:`~splunklib.client.OperationError` class
 
+    :class:`~splunklib.client.OperationFailedException` class
+    
 
 :doc:`data`
 -----------

splunklib/binding.py

@@ -350,7 +350,7 @@ class Context(object):
     Alternately, use the :func:`connect` function to create an already
     authenticated ``Context`` object. Or you may provide a session
     token explicitly (the same token may be shared by multiple
-    ``Context``s), which provides authentication.
+    ``Contexts``), which provides authentication.
 
     :param host: The host name (default: ``"localhost"``).
     :type host: string
@@ -428,7 +428,8 @@ def connect(self):
             import splunklib.binding as binding
             c = binding.connect(...)
             socket = c.connect()
-            socket.write("POST %s HTTP/1.1\r\n" % c._abspath("some/path/to/post/to"))
+            socket.write("POST %s HTTP/1.1\r\n" % \
+                c._abspath("some/path/to/post/to"))
             socket.write("Host: %s:%s\r\n" % (c.host, c.port))
             socket.write("Accept-Encoding: identity\r\n")
             socket.write("Authorization: %s\r\n" % c.token)