BREAKING CHANGE: removed requests from solnlib's dependencies (#412)

sgoral-splunk · web-flow · commit 1016f8783118 · 2024-11-28T14:31:51.000+01:00
**Issue number:[ADDON-73536](https://splunk.atlassian.net/browse/ADDON-73536)** ### PR Type **What kind of change does this PR introduce?** * [x] Breaking change * [ ] Feature * [ ] Bug Fix * [ ] Refactoring (no functional or API changes) * [ ] Documentation Update * [ ] Maintenance (dependency updates, CI, etc.) ## Summary The requests library has been removed from solnlib, so solnlib now depends on the requests library from the running environment. ### Changes removed requests from pyproject.toml ### User experience Solnlib will no longer install requests library. if requests are installed in `<Add-on>/lib` e.g. as a dependency of another library, that version will be taken first. If requests is missing from the add-on’s lib directory, then requests provided from splunk will be used. In case the splunk requests version is not sufficient for the user, user can deliver version he needs by simply adding it to the requirements.txt or pyproject.toml file in the add-on. ## Checklist If an item doesn't apply to your changes, leave it unchecked. * [x] I have performed a self-review of this change according to the [development guidelines](https://splunk.github.io/addonfactory-ucc-generator/contributing/#development-guidelines) * [x] Tests have been added/modified to cover the changes [(testing doc)](https://splunk.github.io/addonfactory-ucc-generator/contributing/#build-and-test) * [x] Changes are documented * [x] PR title and description follows the [contributing principles](https://splunk.github.io/addonfactory-ucc-generator/contributing/#pull-requests)
diff --git a/docs/release_6_0_0.md 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 `<Add-on>/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
@@ -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
diff --git 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"
