Release 1.2

Author: David Noble

.gitattributes

@@ -0,0 +1,2 @@
+tests/searchcommands_data/_expected_results/* binary
+tests/searchcommands_data/input/* binary

.gitignore

@@ -14,4 +14,6 @@ MANIFEST
 coverage_report
 test.log
 examples/*/local
-examples/*/metadata
+examples/*/metadata
+tests/searchcommands_data/log/
+tests/searchcommands_data/output/

CHANGELOG.md

@@ -1,5 +1,33 @@
 # Splunk SDK for Python Changelog
 
+## Version 1.2
+
+### New features and APIs
+
+* Added support for building custom search commands in Python using the Splunk
+  SDK for Python.
+
+### 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.
+
+* When setting the sourcetype of a modular input event, events are indexed properly.
+  Previously Splunk would encounter an error and skip them.
+
+### Breaking changes
+
+* If modular inputs were not being indexed by Splunk because a sourcetype was set
+  (and the SDK was not handling them correctly), they will be indexed upon updating
+  to this version of the SDK.
+
+### Minor changes
+
+* Docstring corrections in the modular input examples.
+
+* A minor docstring correction in `splunklib/modularinput/event_writer.py`.
+
 ## Version 1.1
 
 ### New features and APIs

README.md

@@ -1,6 +1,6 @@
 # The Splunk Software Development Kit for Python
 
-#### Version 1.1
+#### Version 1.2
 
 The Splunk Software Development Kit (SDK) for Python contains library code and 
 examples designed to enable developers to build applications using Splunk.

docs/index.rst

@@ -24,7 +24,7 @@ For more information, see the `Splunk Developer Portal <http://dev.splunk.com/vi
 
     **Custom HTTP handler**
 
-    :class:`~splunklib.binding.HTTPError` class 
+    :class:`~splunklib.binding.HTTPError` class
 
     :class:`~splunklib.binding.HttpLib` class
 
@@ -34,9 +34,9 @@ For more information, see the `Splunk Developer Portal <http://dev.splunk.com/vi
 
     :func:`~splunklib.client.connect` function
 
-    :class:`~splunklib.client.Service` class 
+    :class:`~splunklib.client.Service` class
 
-    :class:`~splunklib.client.Endpoint` base class 
+    :class:`~splunklib.client.Endpoint` base class
 
 
     **Entities and collections**
@@ -88,7 +88,7 @@ For more information, see the `Splunk Developer Portal <http://dev.splunk.com/vi
     :class:`~splunklib.client.User` class
 
     :class:`~splunklib.client.Users` class
-    
+
 
     **Exceptions**
 
@@ -114,28 +114,39 @@ For more information, see the `Splunk Developer Portal <http://dev.splunk.com/vi
 
     :func:`~splunklib.data.record` function
 
-    :class:`~splunklib.data.Record` class 
+    :class:`~splunklib.data.Record` class
 
 :doc:`results`
 --------------
 
-    :class:`~splunklib.results.ResultsReader` class 
+    :class:`~splunklib.results.ResultsReader` class
 
-    :class:`~splunklib.results.Message` class 
+    :class:`~splunklib.results.Message` class
 
 :doc:`modularinput`
---------------
+-------------------
+
+    :class:`~splunklib.modularinput.Argument` class
+
+    :class:`~splunklib.modularinput.Event` class
+
+    :class:`~splunklib.modularinput.EventWriter` class
+
+    :class:`~splunklib.modularinput.InputDefinition` class
+
+    :class:`~splunklib.modularinput.Scheme` class
+
+    :class:`~splunklib.modularinput.Script` class
+
+    :class:`~splunklib.modularinput.ValidationDefinition` class
 
-    :class:`~splunklib.modularinput.Argument` class 
+:doc:`searchcommands`
+---------------------
 
-    :class:`~splunklib.modularinput.Event` class 
+    :class:`~splunklib.searchcommands.GeneratingCommand` class
 
-    :class:`~splunklib.modularinput.EventWriter` class 
+    :class:`~splunklib.searchcommands.ReportingCommand` class
 
-    :class:`~splunklib.modularinput.InputDefinition` class 
+    :class:`~splunklib.searchcommands.StreamingCommand` class
 
-    :class:`~splunklib.modularinput.Scheme` class 
-    
-    :class:`~splunklib.modularinput.Script` class 
-    
-    :class:`~splunklib.modularinput.ValidationDefinition` class 
+    :class:`~splunklib.searchcommands.Option` class

docs/modularinput.rst

@@ -1,5 +1,5 @@
 splunklib.modularinput
---------------
+----------------------
 
 .. automodule:: splunklib.modularinput
 

docs/searchcommands.rst

@@ -0,0 +1,68 @@
+splunklib.searchcommands
+------------------------
+
+.. automodule:: splunklib.searchcommands
+
+.. autofunction:: dispatch
+
+.. automodule:: splunklib.searchcommands.generating_command
+
+.. autoclass:: GeneratingCommand
+    :members:
+    :inherited-members:
+
+.. automodule:: splunklib.searchcommands.reporting_command
+
+.. autoclass:: ReportingCommand
+    :members:
+    :inherited-members:
+
+.. automodule:: splunklib.searchcommands.streaming_command
+
+.. autoclass:: StreamingCommand
+    :members:
+    :inherited-members:
+
+.. automodule:: splunklib.searchcommands.decorators
+
+.. autoclass:: Configuration
+    :members:
+    :inherited-members:
+
+.. autoclass:: Option
+    :members:
+    :inherited-members:
+
+.. automodule:: splunklib.searchcommands.validators
+
+.. autoclass:: splunklib.searchcommands.validators.Boolean
+    :members:
+    :inherited-members:
+
+.. autoclass:: splunklib.searchcommands.validators.Duration
+    :members:
+    :inherited-members:
+
+.. autoclass:: splunklib.searchcommands.validators.Fieldname
+    :members:
+    :inherited-members:
+
+.. autoclass:: splunklib.searchcommands.validators.File
+    :members:
+    :inherited-members:
+
+.. autoclass:: splunklib.searchcommands.validators.Integer
+    :members:
+    :inherited-members:
+
+.. autoclass:: splunklib.searchcommands.validators.RegularExpression
+    :members:
+    :inherited-members:
+
+.. autoclass:: splunklib.searchcommands.validators.Set
+    :members:
+    :inherited-members:
+
+.. autoclass:: splunklib.searchcommands.validators.Validator
+    :members:
+    :inherited-members:

examples/abc/a.py

@@ -1,4 +1,4 @@
-# Copyright 2011-2012 Splunk, Inc.
+# Copyright 2011-2013 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-2012 Splunk, Inc.
+# Copyright 2011-2013 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-2012 Splunk, Inc.
+# Copyright 2011-2013 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