Merge branch 'develop-1.2.0' of https://github.com/splunk/splunk-sdk-python into develop-1.2.0

Author: David Noble

CHANGELOG.md

@@ -1,5 +1,19 @@
 # Splunk SDK for Python Changelog
 
+## Version 1.2
+
+### Bug fix
+
+* When running `setup.py dist` without running `setup.py build`, there is no
+  longer an `No such file or directory` error on the command line, and the
+  command behaves as expected.
+
+### Minor changes
+
+* Docstring corrections in modular input examples.
+
+* A minor docstring correction in `splunklib/modularinput/event_writer.py`.
+
 ## Version 1.1
 
 ### New features and APIs

examples/github_forks/github_forks.py

@@ -110,7 +110,7 @@ def validate_input(self, validation_definition):
     def stream_events(self, inputs, ew):
         """This function handles all the action: splunk calls this modular input
         without arguments, streams XML describing the inputs to stdin, and waits
-        for XML on stout describing events.
+        for XML on stdout describing events.
 
         If you set use_single_instance to True on the scheme in get_scheme, it
         will pass all the instances of this input to a single instance of this

examples/random_numbers/random_numbers.py

@@ -60,7 +60,7 @@ def get_scheme(self):
         min_argument.required_on_create = True
         # If you are not using external validation, you would add something like:
         #
-        # setValidation("min > 0");
+        # scheme.validation = "min > 0"
         scheme.add_argument(min_argument)
 
         max_argument = Argument("max")
@@ -96,7 +96,7 @@ def validate_input(self, validation_definition):
     def stream_events(self, inputs, ew):
         """This function handles all the action: splunk calls this modular input
         without arguments, streams XML describing the inputs to stdin, and waits
-        for XML on stout describing events.
+        for XML on stdout describing events.
 
         If you set use_single_instance to True on the scheme in get_scheme, it
         will pass all the instances of this input to a single instance of this

setup.py

@@ -103,6 +103,9 @@ def run(self):
         splunklib_arcname = "splunklib"
         modinput_dir = os.path.join(splunklib_arcname, "modularinput")
 
+        if not os.path.exists("build"):
+            os.makedirs("build")
+
         for app in app_names:
             with closing(tarfile.open(os.path.join("build", app + ".spl"), "w")) as spl:
                 spl.add(

splunklib/modularinput/event.py

@@ -63,7 +63,7 @@ def __init__(self, data=None, stanza=None, time=None, host=None, index=None, sou
         self.host = host
         self.index = index
         self.source = source
-        self.sourceType = sourcetype
+        self.sourcetype = sourcetype
         self.stanza = stanza
         self.time = time
         self.unbroken = unbroken
@@ -91,7 +91,7 @@ def write_to(self, stream):
         # add all other subelements to this Event, represented by (tag, text)
         subelements = [
             ("source", self.source),
-            ("sourceType", self.sourceType),
+            ("sourcetype", self.sourcetype),
             ("index", self.index),
             ("host", self.host),
             ("data", self.data)

splunklib/modularinput/event_writer.py

@@ -64,7 +64,7 @@ def log(self, severity, message):
         These messages will show up in Splunk's internal logs.
 
         :param severity: ``string``, severity of message, see severites defined as class constants.
-        :param message: Message to log.
+        :param message: ``string``, message to log.
         """
 
         self._err.write("%s %s\n" % (severity, message))