Release 1.4.0

Author: Shakeel Mohamed

.gitignore

@@ -21,3 +21,5 @@ tests/searchcommands_data/output/
 examples/searchcommands_app/searchcommand_app.log
 Test Results*.html
 tests/searchcommands/data/app/app.log
+splunk_sdk.egg-info/
+dist/

CHANGELOG.md

@@ -1,5 +1,45 @@
 # Splunk SDK for Python Changelog
 
+## Version 1.4.0
+
+### New features and APIs
+
+* Added support for cookie-based authentication, for Splunk 6.2+.
+
+* Added support for installing as a Python egg.
+
+* Added a convenience `Service.job()` method to get a `Job` by its sid.
+
+### Bug fixes
+
+* Restored support for Python 2.6 (GitHub issues #96 & #114).
+
+* Fix `SearchCommands` decorators and `Validator` classes (Github issue #113).
+
+* Fix `SearchCommands` bug iterating over `None` in `dict_reader.fieldnames` (Github issue #110).
+
+* Fixed JSON parsing errors (GitHub issue #100).
+
+* Retain the `type` property when parsing Atom feeds (GitHub issue #92).
+
+* Update non-namespaced server paths with a `/services/` prefix. Fixes a bug where setting the `owner` and/or `app` on a `Service` could produce 403 errors on some REST API endpoints.
+
+* Modular input `Argument.title` is now written correctly.
+
+* `Client.connect` will now always return a `Service` instance, even if user credentials are invalid.
+
+* Update the `saved_search/saved_search.py` example to handle saved searches with names containing characters that must be URL encoded (ex: `"Top 5 sourcetypes"`).
+
+### Minor Changes
+
+* Update modular input examples with readable titles.
+
+* Improvements to `splunklib.searchcommands` tests.
+
+* Various docstring and code style corrections.
+
+* Updated some tests to pass on Splunk 6.2+.
+
 ## Version 1.3.1
 
 ### Bug fixes
@@ -15,7 +55,7 @@
 
 * Added a script (GenerateHelloCommand) to the searchcommand_app to generate a custom search command.
 
-* Added a human readable title parameter to `modularinput.argument`.
+* Added a human readable argument titles to modular input examples.
 
 * Renamed the searchcommand `csv` module to `splunk_csv`.
 

README.md

@@ -1,6 +1,6 @@
 # The Splunk Software Development Kit for Python
 
-#### Version 1.3.1
+#### Version 1.4.0
 
 The Splunk Software Development Kit (SDK) for Python contains library code and 
 examples designed to enable developers to build applications using Splunk.
@@ -60,6 +60,10 @@ Or
 
     [sudo] pip install splunk-sdk
 
+Or to install the Python egg
+
+    [sudo] pip install --egg splunk-sdk
+
 Alternatively, you can use **setup.py** on the sources you cloned from GitHub:
 
     [sudo] python setup.py install

docs/binding.rst

@@ -13,7 +13,7 @@ splunklib.binding
     :members:
 
 .. autoclass:: Context
-    :members: connect, delete, get, login, logout, post, request
+    :members: connect, delete, get, get_cookies, has_cookies, login, logout, post, request
 
 .. autoclass:: HTTPError
     :members:

docs/client.rst

@@ -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, storage_passwords, users
+    :members: apps, confs, capabilities, event_types, fired_alerts, indexes, info, inputs, job, jobs, loggers, messages, modular_input_kinds, parse, restart, restart_required, roles, search, saved_searches, settings, splunk_version, storage_passwords, users
     :inherited-members:
 
 .. autoclass:: Settings

examples/analytics/README.md

@@ -73,7 +73,7 @@ Similarly to `AnalyticsTracker`, the `output.py` file defines the "output" side
 of the Analytics service. If you want to extract the events you logged in using
 `AnalyticsTracker`, you'd use the `AnalyticsRetriever` class.
 
-Creating an `AnalyticsTracker` instance is identical to the `AnalyticsTracker`:
+Creating an `AnalyticsRetriever` instance is identical to the `AnalyticsTracker`:
 
 ```python
 from analytics.output import AnalyticsRetriever
@@ -138,7 +138,7 @@ you can see a graph of events over time, properties, etc.
 
 We make use of the excellent open source
 [flot](http://code.google.com/p/flot/) graphing library to render
-our Javascript graphs. We also use the [`bottle.py`](bottlepy.org)
+our Javascript graphs. We also use the [`bottle.py`](http://bottlepy.org)
 micro-web framework.
 
 ## Running the Sample

examples/analytics/input.py

@@ -59,7 +59,7 @@ def __init__(self, application_name, splunk_info, index = ANALYTICS_INDEX_NAME):
 
     @staticmethod
     def encode(props):
-        encoded = " ";
+        encoded = " "
         for k,v in props.iteritems():
             # We disallow dictionaries - it doesn't quite make sense.
             assert(not isinstance(v, dict))

examples/binding1.py

@@ -42,10 +42,10 @@ def indexes(self):
         return self.context.get("data/indexes")
 
     def info(self):
-        return self.context.get("server/info")
+        return self.context.get("/services/server/info")
 
     def settings(self):
-        return self.context.get("server/settings")
+        return self.context.get("/services/server/settings")
 
     def search(self, query, **kwargs):
         return self.context.post("search/jobs/export", search=query, **kwargs)

examples/explorer/server.py

@@ -114,7 +114,7 @@ def make_request(self, url, method, data, headers):
             response_file = StringIO.StringIO(response_text)
 
             # On errors, we also log the response text
-            self.log_message("Response: %s", response_text);
+            self.log_message("Response: %s", response_text)
 
             # Send the error response code
             self.send_response(e.code, message=e.msg)

examples/export/export.py

@@ -328,7 +328,7 @@ def main():
     service = connect(**options.kwargs)
 
     if path.exists(options.kwargs['output']):
-        if options.kwargs['recover'] == False:
+        if not options.kwargs['recover']:
             print "Export file %s exists, and recover option nor specified" % \
                   options.kwargs['output']
             sys.exit(1)