Release/2.0.1

Version 2.0.1

Bug fixes

• #567 Moved "deprecation" dependency

Release 2.0.0

Version 2.0.0

Feature updates

• ensure_binary, ensure_str and assert_regex utility methods have been migrated from six.py to splunklib/utils.py

Major changes

• Removed code specific to Python 2
• Removed six.py dependency
• Removed __future__ imports
• Refactored and Updated splunklib and tests to utilize Python 3 features
• Updated CI test matrix to run with Python versions - 3.7 and 3.9
• Refactored Code throwing deprecation warnings
• Refactored Code violating Pylint rules

Bug fixes

• #527 Added check for user roles
• Fix to access the metadata "finished" field in search commands using the v2 protocol
• Fix for error messages about ChunkedExternProcessor in splunkd.log for Custom Search Commands

Release/1.7.4

Version 1.7.4

Bug fixes

• #532 update encoding errors mode to 'replace' [issue#505]
• #507 masked sensitive data in logs [issue#506]

Minor changes

• #530 Update GitHub CI build status in README and removed RTD(Read The Docs) reference

Release/1.7.3

Version 1.7.3

Bug fixes

• #493 Fixed file permission for event_writer.py file [issue#487]
• #500 Replaced index_field with accelerated_field for kvstore [issue#497]
• #502 Updated check for IPv6 addresses

Minor changes

• #490 Added ACL properties update feature
• #495 Added Splunk 8.1 in GitHub Actions Matrix
• #485 Added test case for cookie persistence
• #503 README updates on accessing "service" instance in CSC and ModularInput apps
• #504 Updated authentication token names in docs to reduce confusion
• #494 Reuse splunklib.version in handler.request

Release/1.7.2

Version 1.7.2

Minor changes

• #482 Special handling related to the semantic versioning of specific Search APIs functional in Splunk Enterprise 9.0.2 and (Splunk Cloud 9.0.2209). These SDK changes will enable seamless transition between the APIs based on the version of the Splunk Enterprise in use

Release/1.7.1

Version 1.7.1

Bug fixes

• #471 Fixed support of Load Balancer "sticky sessions" (persistent cookies) [issue#438]

Minor changes

• #466 tests for CSC apps
• #467 Added 'kwargs' parameter for Saved Search History function
• #475 README updates

Release/1.7.0

Version 1.7.0

New features and APIs

• #468 SDK Support for splunkd search API changes

Bug fixes

• #464 updated checks for wildcards in StoragePasswords [issue#458]

Minor changes

• #463 Preserve thirdparty cookies

Release/1.6.20

Version 1.6.20

New features and APIs

• #442 Optional retries feature added
• #447 Create job support for "output_mode:json" [issue#285]

Bug fixes

• #449 Set cookie [issue#438]
• #460 Remove restart from client.Entity.disable

Minor changes

• #444 Update tox.ini
• #446 Release workflow refactor
• #448 Documentation changes
• #450 Removed examples and it's references from the SDK

Full Changelog: 1.6.19...1.6.20

Release/1.6.19

New features and APIs

• #441 JSONResultsReader added and deprecated ResultsReader
  • Pre-requisite: Query parameter 'output_mode' must be set to 'json'
  • Improves performance by approx ~80-90%
  • ResultsReader is deprecated and will be removed in future releases (NOTE: Please migrate to JSONResultsReader)
• #437 added setup_logging() method in splunklib for logging
• #426 Added new github_commit modular input example
• #392 Break out search argument to option parsing for v2 custom search commands
• #384 Added Float parameter validator for custom search commands
• #371 Modinput preserve 'app' context

Bug fixes

• #439 Modified POST method debug log to not log sensitive body/data
• #431 Add distsearch.conf to Stream Search Command examples [ issue#418 ]
• #419 Hec endpoint issue[ issue#345 ]
• #416 Removed strip() method in load_value() method from data.py file [ issue#400 ]
• #148 Identical entity names will cause an infinite loop

Minor changes

• #440 Github release workflow modified to generate docs
• #430 Fix indentation in README
• #429 documented how to access modular input metadata
• #427 Replace .splunkrc with .env file in test and examples
• #424 Float validator test fix
• #423 Python3 compatibility for ResponseReader.str()
• #422 ordereddict and all its reference removed
• #421 Update README.md
• #387 Update filter.py
• #331 Fix a couple of warnings spotted when running python 2.7 tests
• #330 client: use six.string_types instead of basestring
• #329 client: remove outdated comment in Index.submit
• #262 properly add parameters to request based on the method of the request
• #237 Don't output close tags if you haven't written a start tag
• #149 "handlers" stanza missing in examples/searchcommands_template/default/logging.conf

Release/1.6.18

Version 1.6.18

Bug fixes

• #405 Fix searchcommands_app example
• #406 Fix mod inputs examples
• #407 Fixed issue with Streaming and Generating Custom Search Commands dropping fields that aren't present in the first row of results. More details on how to opt-in to this fix can be found here:
  https://github.com/splunk/splunk-sdk-python/blob/develop/README.md#customization [ issue#401 ]

Minor changes

• #408 Add search mode example
• #409 Add Support for authorization tokens read from .splunkrc [ issue#388 ]
• #413 Default kvstore owner to nobody [ issue#231 ]