Release 1.3.0

Author: Sam Stelle

.gitignore

@@ -17,3 +17,5 @@ examples/*/local
 examples/*/metadata
 tests/searchcommands_data/log/
 tests/searchcommands_data/output/
+examples/searchcommands_app/searchcommand_app.log
+Test Results*.html

CHANGELOG.md

@@ -1,6 +1,26 @@
 # Splunk SDK for Python Changelog
 
 
+## Version 1.3.0
+
+### New features and APIs
+
+* Added support for Storage Passwords. 
+
+* Added a script (GenerateHelloCommand) to the searchcommand_app to generate a custom search command.
+
+* Added a human readable title parameter to `modularinput.argument`.
+
+* Renamed the searchcommand `csv` module to `splunk_csv`.
+
+### Bug fixes
+
+* Now entities that contain slashes in their name can be created, accessed and deleted correctly.
+
+* Fixed a perfomance issue with connecting to Splunk on Windows.
+
+* Improved the `service.restart()` function.
+
 ## Version 1.2.3
 
 ### New features and APIs

Commands.conf.spec.xlsx

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

README.md

@@ -110,7 +110,7 @@ splunklib.client
     :inherited-members:
 
 .. autoclass:: Service
-    :members: apps, confs, capabilities, event_types, fired_alerts, indexes, info, inputs, jobs, loggers, messages, modular_input_kinds, parse, restart, restart_required, roles, search, saved_searches, settings, splunk_version, users
+    :members: apps, confs, capabilities, event_types, fired_alerts, indexes, info, inputs, jobs, loggers, messages, modular_input_kinds, parse, restart, restart_required, roles, search, saved_searches, settings, splunk_version, storage_passwords, users
     :inherited-members:
 
 .. autoclass:: Settings
@@ -121,6 +121,14 @@ splunklib.client
     :members: submit
     :inherited-members:
 
+.. autoclass:: StoragePassword
+    :members: clear_password, encrypted_password, realm, username
+    :inherited-members:
+
+.. autoclass:: StoragePasswords
+    :members: create, delete
+    :inherited-members:
+
 .. autoclass:: User
     :members: role_entities
     :inherited-members:

docs/client.rst

@@ -85,6 +85,10 @@ For more information, see the `Splunk Developer Portal <http://dev.splunk.com/vi
 
     :class:`~splunklib.client.Settings` class
 
+    :class:`~splunklib.client.StoragePassword` class
+
+    :class:`~splunklib.client.StoragePasswords` class
+
     :class:`~splunklib.client.User` class
 
     :class:`~splunklib.client.Users` class

docs/index.rst

@@ -18,11 +18,6 @@
 
 from splunklib.modularinput import *
 
-try:
-    import xml.etree.cElementTree as ET
-except ImportError:
-    import xml.etree.ElementTree as ET
-
 class MyScript(Script):
     """All modular inputs should inherit from the abstract base class Script
     from splunklib.modularinput.script.

examples/github_forks/github_forks.py

@@ -18,11 +18,6 @@
 
 from splunklib.modularinput import *
 
-try:
-    import xml.etree.cElementTree as ET
-except ImportError:
-    import xml.etree.ElementTree as ET
-
 class MyScript(Script):
     """All modular inputs should inherit from the abstract base class Script
     from splunklib.modularinput.script.

examples/random_numbers/random_numbers.py

@@ -1,11 +1,11 @@
-splunk-sdk-python search_commands_app example
+splunk-sdk-python searchcommands_app example
 =============================================
 
-This app provides three examples of custom search commands; one of each of the
-base types:
+This app provides several examples of custom search commands which illustrate each of the base types:
 
  Command      | Type       | Description
 :------------ |:-----------|:----------------------------------------------------
+ generatehello| Generating | Generates a specified number of 'Hello World' events
  simulate     | Generating | Generates a sequence of events drawn from a csv file using repeated random sampling with replacement
  sum          | Reporting  | Adds all the numbers in a set of fields.
  countmatches | Streaming  | Counts the number of non-overlapping matches to a regular expression in a set of fields.
@@ -18,7 +18,8 @@ The app is tested on Splunk 5 and 6. Here is its manifest:
 │   │   └── searchcommands ....... splunklib.searchcommands module
 │   ├── simulate.py .............. SimulateCommand implementation
 │   ├── sum.py ................... SumCommand implementation
-│   └── countmatches.py .......... CountMatchesCommand implementation
+│   ├── countmatches.py .......... CountMatchesCommand implementation
+│   └── generatehello.py ........... HelloWorldCommand implementation
 ├── default
 │   ├── data
 │   │   └── ui

examples/searchcommands_app/README.md

@@ -0,0 +1,30 @@
+#!/usr/bin/env python
+#
+# 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
+# a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
+# WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
+# License for the specific language governing permissions and limitations
+# under the License.
+
+import sys, time
+from splunklib.searchcommands import \
+    dispatch, GeneratingCommand, Configuration, Option, validators
+ 
+@Configuration()
+class GenerateHelloCommand(GeneratingCommand):
+    count = Option(require=True, validate=validators.Integer())
+ 
+    def generate(self):
+        for i in range(1, self.count + 1):
+            text = 'Hello World %d' % i
+            yield {'_time': time.time(), 'event_no': i, '_raw': text } 
+ 
+dispatch(GenerateHelloCommand, sys.argv, sys.stdin, sys.stdout, __name__)