Comment edits; modinput examples are no authored by Splunk; Script.run simplified.

Author: Shakeel Mohamed

examples/github_forks/default/app.conf

@@ -6,6 +6,6 @@ is_visible = 1
 label = Github Repository Forks
 
 [launcher]
-author=Shakeel Mohamed
+author=Splunk
 description=Streams events giving the number of forks of a GitHub repository
 version = 1.0

examples/github_forks/github_forks.py

@@ -69,7 +69,7 @@ def get_scheme(self):
         repo_name_argument.required_on_create = True
         scheme.add_argument(repo_name_argument)
 
-        return scheme # Return the scheme
+        return scheme
 
     def validate_input(self, validation_definition):
         """In this example we are using external validation to verify that the Github
@@ -141,4 +141,4 @@ def stream_events(self, inputs, ew):
             ew.write_event(event)
 
 if __name__ == "__main__":
-    sys.exit(MyScript().run(sys.argv[1:]))
+    sys.exit(MyScript().run(sys.argv))

examples/random_numbers/default/app.conf

@@ -6,6 +6,6 @@ is_visible = 1
 label = Random Numbers
 
 [launcher]
-author=Shakeel Mohamed
+author=Splunk
 description=Streams events containing a random number
 version = 1.0

examples/random_numbers/random_numbers.py

@@ -69,7 +69,7 @@ def get_scheme(self):
         max_argument.required_on_create = True
         scheme.add_argument(max_argument)
 
-        return scheme # Return the scheme
+        return scheme
 
     def validate_input(self, validation_definition):
         """In this example we are using external validation to verify that min is
@@ -120,4 +120,4 @@ def stream_events(self, inputs, ew):
             ew.write_event(event)
 
 if __name__ == "__main__":
-    sys.exit(MyScript().run(sys.argv[1:]))
+    sys.exit(MyScript().run(sys.argv))

setup.py

@@ -83,11 +83,11 @@ def setup_examples():
     modinput_dir = os.path.join(splunklib_dir, "modularinput")
 
     for app in app_names:
-        spl = tarfile.open(os.path.join("build", app+".spl"), "w")
+        spl = tarfile.open(os.path.join("build", app + ".spl"), "w")
 
         spl.add(
-            os.path.join("examples", app, app+".py"),
-            arcname=os.path.join(app, "bin", app+".py")
+            os.path.join("examples", app, app + ".py"),
+            arcname=os.path.join(app, "bin", app + ".py")
         )
 
         spl.add(

splunklib/modularinput/__init__.py

@@ -1,3 +1,8 @@
+"""The following imports allow these classes to be imported via
+the splunklib.modularinput package like so:
+
+from splunklib.modularinput import *
+"""
 from argument import Argument
 from event import Event
 from event_writer import EventWriter

splunklib/modularinput/script.py

@@ -58,15 +58,15 @@ def run_script(self, args, event_writer, input_stream):
         """
 
         try:
-            if len(args) == 0:
+            if len(args) == 1:
                 # This script is running as an input. Input definitions will be passed on stdin
                 # as XML, and the script will write events on stdout and log entries on stderr.
                 input_definition = InputDefinition.parse(input_stream)
                 self.stream_events(input_definition, event_writer)
                 event_writer.close()
                 return 0
 
-            elif str(args[0]).lower() == "--scheme":
+            elif str(args[1]).lower() == "--scheme":
                 # Splunk has requested XML specifying the scheme for this modular input.
                 # Return it and exit.
                 scheme = self.get_scheme()
@@ -77,7 +77,7 @@ def run_script(self, args, event_writer, input_stream):
                     event_writer.write_xml_document(scheme.to_xml())
                     return 0
 
-            elif args[0].lower() == "--validate-arguments":
+            elif args[1].lower() == "--validate-arguments":
                 validation_definition = ValidationDefinition.parse(input_stream)
                 try:
                     self.validate_input(validation_definition)