Release 1.2.1

Author: David Noble

CHANGELOG.md

@@ -1,5 +1,64 @@
 # Splunk SDK for Python Changelog
 
+## Version 1.2.1
+
+### New features and APIs
+
+* Added features for building custom search commands in Python
+
+  1. Access Splunk Search Results Info.
+
+     See the `SearchCommand.search_results_info` property.
+
+  2. Communicate with Splunk.
+
+     See the `SearchCommand.service` property.
+
+  3. Control logging and view command configuration settings from the Splunk
+     command line
+
+     + The `logging_configuration` option lets you pick an alternative logging
+       configuration file for a command invocation.
+
+     + The `logging_level` option lets you set the logging level for a command
+       invocation.
+
+     + The `show_configuration` option writes command configuration settings
+       to the Splunk Job Inspector.
+
+  4. Get a more complete picture of what's happening when an error occurs
+
+     Command error messages now include a full stack trace.
+
+  5. Enable the Splunk Search Assistant to display command help.
+
+     See `examples/searchcommands_app/default/searchbnf.conf`
+
+  6. Write messages for display by the job inspector.
+
+     See `SearchCommand.messages_header`.
+
+* Added a feature for building modular inputs.
+
+  1. Communicate with Splunk.
+
+     See the `Script.service` property.
+
+### Bug fixes
+
+* 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.
+
+* When setting the sourcetype of a modular input event, events are indexed
+  properly.
+
+  Previously Splunk would encounter an error and skip them.
+
+### Quality improvements
+
+* Better code documentation and unit test coverage.
+
 ## Version 1.2
 
 ### New features and APIs

README.md

@@ -1,6 +1,6 @@
 # The Splunk Software Development Kit for Python
 
-#### Version 1.2
+#### Version 1.2.1
 
 The Splunk Software Development Kit (SDK) for Python contains library code and 
 examples designed to enable developers to build applications using Splunk.
@@ -72,7 +72,7 @@ examples and unit tests from the SDK.
 
 To run the examples and unit tests, you must put the root of
 the SDK on your PYTHONPATH. For example, if you have downloaded the SDK to your
-home folder and are running Mac OS X or Linux, add the following line to your
+home folder and are running OS X or Linux, add the following line to your
 **.bash_profile**:
 
     export PYTHONPATH=~/splunk-sdk-python
@@ -108,7 +108,7 @@ To use this convenience file, create a text file with the following format:
 
 Save the file as **.splunkrc** in the current user's home directory.
 
-*   For example on Mac OS X, save the file as: 
+*   For example on OS X, save the file as: 
 
         ~/.splunkrc
 

docs/searchcommands.rst

@@ -3,27 +3,51 @@ splunklib.searchcommands
 
 .. automodule:: splunklib.searchcommands
 
-.. autofunction:: dispatch
-
-.. automodule:: splunklib.searchcommands.generating_command
+.. autofunction:: dispatch(command_class[, argv=sys.argv, input_file=sys.stdin, output_file=sys.stdout, module_name=None])
 
 .. autoclass:: GeneratingCommand
     :members:
     :inherited-members:
+    :exclude-members: ConfigurationSettings, generate, process
+
+    .. autoclass:: splunklib.searchcommands::GeneratingCommand.ConfigurationSettings
+        :members:
+        :inherited-members:
+        :exclude-members: configuration_settings, fix_up, items, keys
+
+    .. automethod:: splunklib.searchcommands::GeneratingCommand.generate
 
-.. automodule:: splunklib.searchcommands.reporting_command
+    .. automethod:: splunklib.searchcommands::GeneratingCommand.process(args=sys.argv[, input_file=sys.stdin, output_file=sys.stdout])
 
 .. autoclass:: ReportingCommand
     :members:
     :inherited-members:
+    :exclude-members: ConfigurationSettings, map, process, reduce
+
+    .. autoclass:: splunklib.searchcommands::ReportingCommand.ConfigurationSettings
+        :members:
+        :inherited-members:
+        :exclude-members: configuration_settings, fix_up, items, keys
+
+    .. automethod:: splunklib.searchcommands::ReportingCommand.map
 
-.. automodule:: splunklib.searchcommands.streaming_command
+    .. automethod:: splunklib.searchcommands::ReportingCommand.process(args=sys.argv[, input_file=sys.stdin, output_file=sys.stdout])
+
+    .. automethod:: splunklib.searchcommands::ReportingCommand.reduce
 
 .. autoclass:: StreamingCommand
     :members:
     :inherited-members:
+    :exclude-members: ConfigurationSettings, process, stream
+
+    .. autoclass:: splunklib.searchcommands::StreamingCommand.ConfigurationSettings
+        :members:
+        :inherited-members:
+        :exclude-members: configuration_settings, fix_up, items, keys
 
-.. automodule:: splunklib.searchcommands.decorators
+    .. automethod:: splunklib.searchcommands::StreamingCommand.process(args=sys.argv[, input_file=sys.stdin, output_file=sys.stdout])
+
+    .. automethod:: splunklib.searchcommands::StreamingCommand.stream
 
 .. autoclass:: Configuration
     :members:
@@ -32,37 +56,36 @@ splunklib.searchcommands
 .. autoclass:: Option
     :members:
     :inherited-members:
+    :exclude-members: Item, View, fix_up
 
-.. automodule:: splunklib.searchcommands.validators
-
-.. autoclass:: splunklib.searchcommands.validators.Boolean
+.. autoclass:: Boolean
     :members:
     :inherited-members:
 
-.. autoclass:: splunklib.searchcommands.validators.Duration
+.. autoclass:: Duration
     :members:
     :inherited-members:
 
-.. autoclass:: splunklib.searchcommands.validators.Fieldname
+.. autoclass:: Fieldname
     :members:
     :inherited-members:
 
-.. autoclass:: splunklib.searchcommands.validators.File
+.. autoclass:: File
     :members:
     :inherited-members:
 
-.. autoclass:: splunklib.searchcommands.validators.Integer
+.. autoclass:: Integer
     :members:
     :inherited-members:
 
-.. autoclass:: splunklib.searchcommands.validators.RegularExpression
+.. autoclass:: RegularExpression
     :members:
     :inherited-members:
 
-.. autoclass:: splunklib.searchcommands.validators.Set
+.. autoclass:: Set
     :members:
     :inherited-members:
 
-.. autoclass:: splunklib.searchcommands.validators.Validator
+.. autoclass:: Validator
     :members:
     :inherited-members:

examples/abc/a.py

@@ -1,4 +1,4 @@
-# Copyright 2011-2013 Splunk, Inc.
+# Copyright 2011-2014 Splunk, Inc.
 #
 # Licensed under the Apache License, Version 2.0 (the "License"): you may
 # not use this file except in compliance with the License. You may obtain

examples/abc/b.py

@@ -1,4 +1,4 @@
-# Copyright 2011-2013 Splunk, Inc.
+# Copyright 2011-2014 Splunk, Inc.
 #
 # Licensed under the Apache License, Version 2.0 (the "License"): you may
 # not use this file except in compliance with the License. You may obtain

examples/abc/c.py

@@ -1,4 +1,4 @@
-# Copyright 2011-2013 Splunk, Inc.
+# Copyright 2011-2014 Splunk, Inc.
 #
 # Licensed under the Apache License, Version 2.0 (the "License"): you may
 # not use this file except in compliance with the License. You may obtain

examples/analytics/__init__.py

@@ -1,6 +1,6 @@
 #!/usr/bin/env python
 #
-# Copyright 2011-2013 Splunk, Inc.
+# Copyright 2011-2014 Splunk, Inc.
 #
 # Licensed under the Apache License, Version 2.0 (the "License"): you may
 # not use this file except in compliance with the License. You may obtain

examples/analytics/input.py

@@ -1,6 +1,6 @@
 #!/usr/bin/env python
 #
-# Copyright 2011-2013 Splunk, Inc.
+# Copyright 2011-2014 Splunk, Inc.
 #
 # Licensed under the Apache License, Version 2.0 (the "License"): you may
 # not use this file except in compliance with the License. You may obtain

examples/analytics/output.py

@@ -1,6 +1,6 @@
 #!/usr/bin/env python
 #
-# Copyright 2011-2013 Splunk, Inc.
+# Copyright 2011-2014 Splunk, Inc.
 #
 # Licensed under the Apache License, Version 2.0 (the "License"): you may
 # not use this file except in compliance with the License. You may obtain

examples/analytics/server.py

@@ -1,6 +1,6 @@
 #!/usr/bin/env python
 #
-# Copyright 2011-2013 Splunk, Inc.
+# Copyright 2011-2014 Splunk, Inc.
 #
 # Licensed under the Apache License, Version 2.0 (the "License"): you may
 # not use this file except in compliance with the License. You may obtain