From 97d8c06b615c61bdb616bcd719c24a75149ae808 Mon Sep 17 00:00:00 2001 From: srv-rr-github-token <94607705+srv-rr-github-token@users.noreply.github.com> Date: Tue, 26 Nov 2024 10:40:38 +0000 Subject: [PATCH 1/5] chore(release): 5.5.0 # [5.5.0](https://github.com/splunk/addonfactory-solutions-library-python/compare/v5.4.0...v5.5.0) (2024-11-26) ### Features * add function to get the proxy details ([#406](https://github.com/splunk/addonfactory-solutions-library-python/issues/406)) ([c9e1f73](https://github.com/splunk/addonfactory-solutions-library-python/commit/c9e1f7350620963422747d90cfde529d3bb17511)) --- pyproject.toml | 2 +- solnlib/__init__.py | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/pyproject.toml b/pyproject.toml index d9b580ef..673bdd52 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -16,7 +16,7 @@ [tool.poetry] name = "solnlib" -version = "5.5.0-beta.1" +version = "5.5.0" description = "The Splunk Software Development Kit for Splunk Solutions" authors = ["Splunk "] license = "Apache-2.0" diff --git a/solnlib/__init__.py b/solnlib/__init__.py index 2f45611c..0d92fb1f 100644 --- a/solnlib/__init__.py +++ b/solnlib/__init__.py @@ -56,4 +56,4 @@ "utils", ] -__version__ = "5.5.0-beta.1" +__version__ = "5.5.0" From a6fa555ec8e724654a03fe200a94f643fd1c229e Mon Sep 17 00:00:00 2001 From: sgoral-splunk <138458044+sgoral-splunk@users.noreply.github.com> Date: Thu, 28 Nov 2024 16:03:03 +0100 Subject: [PATCH 2/5] feat: removing requests and urllib3 dependencies (#413) BREAKING CHANGE: removing requests and urllib3 dependencies --- docs/release_6_0_0.md | 16 ++++++++++++++++ mkdocs.yml | 1 + poetry.lock | 3 +-- pyproject.toml | 2 -- 4 files changed, 18 insertions(+), 4 deletions(-) create mode 100644 docs/release_6_0_0.md diff --git a/docs/release_6_0_0.md b/docs/release_6_0_0.md new file mode 100644 index 00000000..63b3af92 --- /dev/null +++ b/docs/release_6_0_0.md @@ -0,0 +1,16 @@ +# Removed requests and urllib3 from solnlib +The `requests` and `urllib3` libraries has been removed from solnlib, so solnlib now depends on the `requests` and `urllib3` libraries from the running environment. +By default, Splunk delivers the above libraries and their version depends on the Splunk version. More information [here](https://docs.splunk.com/Documentation/Splunk/9.2.3/ReleaseNotes/Credits). + +**IMPORTANT**: `urllib3` is available in Splunk `v8.1.0` and later + +Please note that if `requests` or `urllib3` are installed in `/lib` e.g. as a dependency of another library, that version will be taken first. +If `requests` or `urllib3` is missing in the add-on's `lib` directory, the version provided by Splunk will be used. + +## Custom Version of requests and urllib3 +In case the Splunk's `requests` or `urllib3` version is not sufficient for you, +you can deliver version you need by simply adding it to the `requirements.txt` or `pyproject.toml` file in your add-on. + +## Use solnlib outside the Splunk +**Solnlib** no longer provides `requests` and `urllib3` so if you want to use **solnlib** outside the Splunk, please note that you will need to +provide these libraries yourself in the environment where **solnlib** is used. diff --git a/mkdocs.yml b/mkdocs.yml index 5aa2bfaa..f0742b0e 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -30,6 +30,7 @@ plugins: nav: - Home: index.md + - Release 6.0.0: release_6_0_0.md - References: - modular_input: - "checkpointer.py": modular_input/checkpointer.md diff --git a/poetry.lock b/poetry.lock index 49a816f5..022d5f55 100644 --- a/poetry.lock +++ b/poetry.lock @@ -727,7 +727,6 @@ files = [ {file = "PyYAML-6.0.1-cp311-cp311-win_amd64.whl", hash = "sha256:bf07ee2fef7014951eeb99f56f39c9bb4af143d8aa3c21b1677805985307da34"}, {file = "PyYAML-6.0.1-cp312-cp312-macosx_10_9_x86_64.whl", hash = "sha256:855fb52b0dc35af121542a76b9a84f8d1cd886ea97c84703eaa6d88e37a2ad28"}, {file = "PyYAML-6.0.1-cp312-cp312-macosx_11_0_arm64.whl", hash = "sha256:40df9b996c2b73138957fe23a16a4f0ba614f4c0efce1e9406a184b6d07fa3a9"}, - {file = "PyYAML-6.0.1-cp312-cp312-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:a08c6f0fe150303c1c6b71ebcd7213c2858041a7e01975da3a99aed1e7a378ef"}, {file = "PyYAML-6.0.1-cp312-cp312-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:6c22bec3fbe2524cde73d7ada88f6566758a8f7227bfbf93a408a9d86bcc12a0"}, {file = "PyYAML-6.0.1-cp312-cp312-musllinux_1_1_x86_64.whl", hash = "sha256:8d4e9c88387b0f5c7d5f281e55304de64cf7f9c0021a3525bd3b1c542da3b0e4"}, {file = "PyYAML-6.0.1-cp312-cp312-win32.whl", hash = "sha256:d483d2cdf104e7c9fa60c544d92981f12ad66a457afae824d146093b8c294c54"}, @@ -1024,4 +1023,4 @@ testing = ["big-O", "flake8 (<5)", "jaraco.functools", "jaraco.itertools", "more [metadata] lock-version = "2.0" python-versions = ">=3.7,<3.14" -content-hash = "355e3165623b332a6856b7959863e7dbf61f9f22fc0b880aede1d84cc3c53dba" +content-hash = "e24950c3694801361bf9956c190d77a0c5f2fdb82786f4a101ab50de34932920" diff --git a/pyproject.toml b/pyproject.toml index 673bdd52..d1ffef0e 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -40,8 +40,6 @@ classifiers = [ [tool.poetry.dependencies] python = ">=3.7,<3.14" -requests = "^2.31.0" -urllib3 = "<2" sortedcontainers = ">=2" defusedxml = ">=0.7" splunk-sdk = ">=1.6" From ce6a2ca243f8aa0e3165035bd97551de4ef3bf5b Mon Sep 17 00:00:00 2001 From: srv-rr-github-token <94607705+srv-rr-github-token@users.noreply.github.com> Date: Thu, 28 Nov 2024 15:08:21 +0000 Subject: [PATCH 3/5] chore(release): 6.0.0 # [6.0.0](https://github.com/splunk/addonfactory-solutions-library-python/compare/v5.5.0...v6.0.0) (2024-11-28) ### Features * removing requests and urllib3 dependencies ([#413](https://github.com/splunk/addonfactory-solutions-library-python/issues/413)) ([a6fa555](https://github.com/splunk/addonfactory-solutions-library-python/commit/a6fa555ec8e724654a03fe200a94f643fd1c229e)) ### BREAKING CHANGES * removing requests and urllib3 dependencies --- pyproject.toml | 2 +- solnlib/__init__.py | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/pyproject.toml b/pyproject.toml index d1ffef0e..b6d5357c 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -16,7 +16,7 @@ [tool.poetry] name = "solnlib" -version = "5.5.0" +version = "6.0.0" description = "The Splunk Software Development Kit for Splunk Solutions" authors = ["Splunk "] license = "Apache-2.0" diff --git a/solnlib/__init__.py b/solnlib/__init__.py index 0d92fb1f..136a4b9f 100644 --- a/solnlib/__init__.py +++ b/solnlib/__init__.py @@ -56,4 +56,4 @@ "utils", ] -__version__ = "5.5.0" +__version__ = "6.0.0" From f50bf52abdc7ce1afb8f50f8a427e6c70421c3ac Mon Sep 17 00:00:00 2001 From: Artem Rys Date: Fri, 29 Nov 2024 13:07:46 +0100 Subject: [PATCH 4/5] fix: require splunk-sdk at least 2.0.2 (#414) Jira: https://splunk.atlassian.net/browse/ADDON-77054 This PR makes sure that `solnlib` will require at least `2.0.2` version of `splunk-sdk`. --- poetry.lock | 3 ++- pyproject.toml | 2 +- 2 files changed, 3 insertions(+), 2 deletions(-) diff --git a/poetry.lock b/poetry.lock index 022d5f55..c5661738 100644 --- a/poetry.lock +++ b/poetry.lock @@ -727,6 +727,7 @@ files = [ {file = "PyYAML-6.0.1-cp311-cp311-win_amd64.whl", hash = "sha256:bf07ee2fef7014951eeb99f56f39c9bb4af143d8aa3c21b1677805985307da34"}, {file = "PyYAML-6.0.1-cp312-cp312-macosx_10_9_x86_64.whl", hash = "sha256:855fb52b0dc35af121542a76b9a84f8d1cd886ea97c84703eaa6d88e37a2ad28"}, {file = "PyYAML-6.0.1-cp312-cp312-macosx_11_0_arm64.whl", hash = "sha256:40df9b996c2b73138957fe23a16a4f0ba614f4c0efce1e9406a184b6d07fa3a9"}, + {file = "PyYAML-6.0.1-cp312-cp312-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:a08c6f0fe150303c1c6b71ebcd7213c2858041a7e01975da3a99aed1e7a378ef"}, {file = "PyYAML-6.0.1-cp312-cp312-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:6c22bec3fbe2524cde73d7ada88f6566758a8f7227bfbf93a408a9d86bcc12a0"}, {file = "PyYAML-6.0.1-cp312-cp312-musllinux_1_1_x86_64.whl", hash = "sha256:8d4e9c88387b0f5c7d5f281e55304de64cf7f9c0021a3525bd3b1c542da3b0e4"}, {file = "PyYAML-6.0.1-cp312-cp312-win32.whl", hash = "sha256:d483d2cdf104e7c9fa60c544d92981f12ad66a457afae824d146093b8c294c54"}, @@ -1023,4 +1024,4 @@ testing = ["big-O", "flake8 (<5)", "jaraco.functools", "jaraco.itertools", "more [metadata] lock-version = "2.0" python-versions = ">=3.7,<3.14" -content-hash = "e24950c3694801361bf9956c190d77a0c5f2fdb82786f4a101ab50de34932920" +content-hash = "7296af4efc8a409147dfcfc840895f32432578649836d5906506225d3be8e58a" diff --git a/pyproject.toml b/pyproject.toml index b6d5357c..23c1a75d 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -42,7 +42,7 @@ classifiers = [ python = ">=3.7,<3.14" sortedcontainers = ">=2" defusedxml = ">=0.7" -splunk-sdk = ">=1.6" +splunk-sdk = ">=2.0.2" [tool.poetry.group.dev.dependencies] pytest = ">=7" From d46cd2194272a2db1493251997b7623813613570 Mon Sep 17 00:00:00 2001 From: srv-rr-github-token <94607705+srv-rr-github-token@users.noreply.github.com> Date: Fri, 29 Nov 2024 12:13:30 +0000 Subject: [PATCH 5/5] chore(release): 6.0.1 ## [6.0.1](https://github.com/splunk/addonfactory-solutions-library-python/compare/v6.0.0...v6.0.1) (2024-11-29) ### Bug Fixes * require splunk-sdk at least 2.0.2 ([#414](https://github.com/splunk/addonfactory-solutions-library-python/issues/414)) ([f50bf52](https://github.com/splunk/addonfactory-solutions-library-python/commit/f50bf52abdc7ce1afb8f50f8a427e6c70421c3ac)) --- pyproject.toml | 2 +- solnlib/__init__.py | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/pyproject.toml b/pyproject.toml index 23c1a75d..f85ee9e3 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -16,7 +16,7 @@ [tool.poetry] name = "solnlib" -version = "6.0.0" +version = "6.0.1" description = "The Splunk Software Development Kit for Splunk Solutions" authors = ["Splunk "] license = "Apache-2.0" diff --git a/solnlib/__init__.py b/solnlib/__init__.py index 136a4b9f..245e4a96 100644 --- a/solnlib/__init__.py +++ b/solnlib/__init__.py @@ -56,4 +56,4 @@ "utils", ] -__version__ = "6.0.0" +__version__ = "6.0.1"