From 62f62cad44ec3e273963bc64f9044e8c136f3fd4 Mon Sep 17 00:00:00 2001 From: ncanumalla-splunk <88208094+ncanumalla-splunk@users.noreply.github.com> Date: Tue, 21 Dec 2021 13:57:41 -0800 Subject: [PATCH 1/5] Create initial pr_template for SDKs --- .github/PULL_REQUEST_TEMPLATE/pr_template.md | 21 ++++++++++++++++++++ 1 file changed, 21 insertions(+) create mode 100644 .github/PULL_REQUEST_TEMPLATE/pr_template.md diff --git a/.github/PULL_REQUEST_TEMPLATE/pr_template.md b/.github/PULL_REQUEST_TEMPLATE/pr_template.md new file mode 100644 index 000000000..95eac9a27 --- /dev/null +++ b/.github/PULL_REQUEST_TEMPLATE/pr_template.md @@ -0,0 +1,21 @@ +## Description of PR + +Provide the **context and motivation** for this PR. +Briefly explain the **type of changes** (bug fix, feature request, doc update, etc.) made in this PR. Provide reference to issue # fixed, if applicable. + +Describe the approach to the solution, the changes made, and any resulting change in behavior or impact to the user. + +## Testing the changes + +Please ensure tests are added for your changes. +Include details of **types of tests** written for the changes in the PR and any **test setup and configuration** required to run the tests. +Mention the **versions of the SDK, language runtime, OS and details of Splunk deployment** used in testing. + +## Documentation + +Please ensure **comments** are added for your changes and any **relevant docs** (readme, reference docs, etc.) are updated. +Include any references to documentation related to the changes. + +## Dependencies and other resources + +Provide references to PRs or things **dependent on this change** and any relevant PRs or resources like style guides and tools used in this PR. From ef88e9d3e90ab9d6cf48cf940c7376400ed759b8 Mon Sep 17 00:00:00 2001 From: ncanumalla-splunk <88208094+ncanumalla-splunk@users.noreply.github.com> Date: Tue, 21 Dec 2021 14:01:41 -0800 Subject: [PATCH 2/5] Add metadata for PR template --- .github/PULL_REQUEST_TEMPLATE/pr_template.md | 9 +++++++++ 1 file changed, 9 insertions(+) diff --git a/.github/PULL_REQUEST_TEMPLATE/pr_template.md b/.github/PULL_REQUEST_TEMPLATE/pr_template.md index 95eac9a27..9fd37c3cf 100644 --- a/.github/PULL_REQUEST_TEMPLATE/pr_template.md +++ b/.github/PULL_REQUEST_TEMPLATE/pr_template.md @@ -1,3 +1,12 @@ +--- +name: Pull Request Template +about: Create a Pull Request to contribute to the SDK +title: '' +labels: '' +assignees: '' + +--- + ## Description of PR Provide the **context and motivation** for this PR. From 313e97bd50396bbc50fabe762bf9164fa0b93338 Mon Sep 17 00:00:00 2001 From: tdhellmann Date: Tue, 22 Feb 2022 08:15:54 -0800 Subject: [PATCH 3/5] Docs updates for #434 Updating broken docs link and adding links to additional references. --- splunklib/searchcommands/__init__.py | 8 ++++++-- 1 file changed, 6 insertions(+), 2 deletions(-) diff --git a/splunklib/searchcommands/__init__.py b/splunklib/searchcommands/__init__.py index c56c510d5..8a929039c 100644 --- a/splunklib/searchcommands/__init__.py +++ b/splunklib/searchcommands/__init__.py @@ -134,9 +134,13 @@ .. topic:: References - 1. `Search command style guide `__ + 1. `Custom Search Command manual: `__ - 2. `Commands.conf.spec `_ + 2. `Create Custom Search Commands with commands.conf.spec `_ + + 3. `Configure seach assistant with searchbnf.conf `_ + + 4. `Control search distribution with distsearch.conf `_ """ From 7b0b486302dfd08fb2a56fc7f9082ceadbc673fc Mon Sep 17 00:00:00 2001 From: akaila-splunk Date: Fri, 25 Mar 2022 18:20:47 +0530 Subject: [PATCH 4/5] release/1.6.19 changes --- CHANGELOG.md | 37 +++++++++++++++++++++++++++++++++++++ README.md | 2 +- splunklib/__init__.py | 2 +- splunklib/binding.py | 2 +- 4 files changed, 40 insertions(+), 3 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 7edf338d6..78d7edbc2 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,5 +1,42 @@ # Splunk Enterprise SDK for Python Changelog +## Version 1.6.19 + +### New features and APIs +* [#441](https://github.com/splunk/splunk-sdk-python/pull/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](https://github.com/splunk/splunk-sdk-python/pull/437) added setup_logging() method in splunklib for logging +* [#426](https://github.com/splunk/splunk-sdk-python/pull/426) Added new github_commit modular input example +* [#392](https://github.com/splunk/splunk-sdk-python/pull/392) Break out search argument to option parsing for v2 custom search commands +* [#384](https://github.com/splunk/splunk-sdk-python/pull/384) Added Float parameter validator for custom search commands +* [#371](https://github.com/splunk/splunk-sdk-python/pull/371) Modinput preserve 'app' context + +### Bug fixes +* [#439](https://github.com/splunk/splunk-sdk-python/pull/439) Modified POST method debug log to not log sensitive body/data +* [#431](https://github.com/splunk/splunk-sdk-python/pull/431) Add distsearch.conf to Stream Search Command examples [ [issue#418](https://github.com/splunk/splunk-sdk-python/issues/418) ] +* [#419](https://github.com/splunk/splunk-sdk-python/pull/419) Hec endpoint issue[ [issue#345](https://github.com/splunk/splunk-sdk-python/issues/345) ] +* [#416](https://github.com/splunk/splunk-sdk-python/pull/416) Removed strip() method in load_value() method from data.py file [ [issue#400](https://github.com/splunk/splunk-sdk-python/issues/400) ] +* [#148](https://github.com/splunk/splunk-sdk-python/pull/148) Identical entity names will cause an infinite loop + +### Minor changes +* [#440](https://github.com/splunk/splunk-sdk-python/pull/440) Github release workflow modified to generate docs +* [#430](https://github.com/splunk/splunk-sdk-python/pull/430) Fix indentation in README +* [#429](https://github.com/splunk/splunk-sdk-python/pull/429) documented how to access modular input metadata +* [#427](https://github.com/splunk/splunk-sdk-python/pull/427) Replace .splunkrc with .env file in test and examples +* [#424](https://github.com/splunk/splunk-sdk-python/pull/424) Float validator test fix +* [#423](https://github.com/splunk/splunk-sdk-python/pull/423) Python3 compatibility for ResponseReader.__str__() +* [#422](https://github.com/splunk/splunk-sdk-python/pull/422) ordereddict and all its reference removed +* [#421](https://github.com/splunk/splunk-sdk-python/pull/421) Update README.md +* [#387](https://github.com/splunk/splunk-sdk-python/pull/387) Update filter.py +* [#331](https://github.com/splunk/splunk-sdk-python/pull/331) Fix a couple of warnings spotted when running python 2.7 tests +* [#330](https://github.com/splunk/splunk-sdk-python/pull/330) client: use six.string_types instead of basestring +* [#329](https://github.com/splunk/splunk-sdk-python/pull/329) client: remove outdated comment in Index.submit +* [#262](https://github.com/splunk/splunk-sdk-python/pull/262) properly add parameters to request based on the method of the request +* [#237](https://github.com/splunk/splunk-sdk-python/pull/237) Don't output close tags if you haven't written a start tag +* [#149](https://github.com/splunk/splunk-sdk-python/pull/149) "handlers" stanza missing in examples/searchcommands_template/default/logging.conf + ## Version 1.6.18 ### Bug fixes diff --git a/README.md b/README.md index 252f0231e..77dedf876 100644 --- a/README.md +++ b/README.md @@ -3,7 +3,7 @@ # The Splunk Enterprise Software Development Kit for Python -#### Version 1.6.18 +#### Version 1.6.19 The Splunk Enterprise Software Development Kit (SDK) for Python contains library code and examples designed to enable developers to build applications using the Splunk platform. diff --git a/splunklib/__init__.py b/splunklib/__init__.py index 5b7c32122..87d26b749 100644 --- a/splunklib/__init__.py +++ b/splunklib/__init__.py @@ -31,5 +31,5 @@ def setup_logging(level, log_format=DEFAULT_LOG_FORMAT, date_format=DEFAULT_DATE format=log_format, datefmt=date_format) -__version_info__ = (1, 6, 18) +__version_info__ = (1, 6, 19) __version__ = ".".join(map(str, __version_info__)) diff --git a/splunklib/binding.py b/splunklib/binding.py index 85713a22c..6bf4f0714 100644 --- a/splunklib/binding.py +++ b/splunklib/binding.py @@ -1414,7 +1414,7 @@ def request(url, message, **kwargs): head = { "Content-Length": str(len(body)), "Host": host, - "User-Agent": "splunk-sdk-python/1.6.18", + "User-Agent": "splunk-sdk-python/1.6.19", "Accept": "*/*", "Connection": "Close", } # defaults From 24529d02bba40fea84086a1ada8e572792927268 Mon Sep 17 00:00:00 2001 From: akaila-splunk Date: Tue, 29 Mar 2022 19:58:14 +0530 Subject: [PATCH 5/5] Update tox.ini - added jinja2 version criteria --- tox.ini | 1 + 1 file changed, 1 insertion(+) diff --git a/tox.ini b/tox.ini index 58ee004ca..00ad22b8d 100644 --- a/tox.ini +++ b/tox.ini @@ -48,4 +48,5 @@ commands = coverage erase description = invoke sphinx-build to build the HTML docs basepython = python3.7 deps = sphinx >= 1.7.5, < 2 + jinja2 < 3.1.0 commands = make -C docs/ html \ No newline at end of file