Skip to content

Commit

Permalink
BREAKING CHANGE: removed urllib3 from solnlib dependencies
Browse files Browse the repository at this point in the history
  • Loading branch information
sgoral-splunk committed Nov 27, 2024
1 parent ae5cecb commit ecbb499
Show file tree
Hide file tree
Showing 2 changed files with 7 additions and 6 deletions.
12 changes: 7 additions & 5 deletions docs/release_6_0_0.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,10 @@
# Removed requests from solnlib
# Removed requests and urllib3 from solnlib

The `requests` library has been removed from solnlib, so solnlib now depends on the `requests` library from the running environment.
By default, splunk delivers `requests` whose version depends on the splunk version. More information [here](https://docs.splunk.com/Documentation/Splunk/9.2.3/ReleaseNotes/Credits).
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).

Please note that if `requests` are installed in `<Add-on>/lib` e.g. as a dependency of another library, that version will be taken first.
If `requests` are 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 you,
**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. In case the Splunk `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.
1 change: 0 additions & 1 deletion pyproject.toml
Original file line number Diff line number Diff line change
Expand Up @@ -40,7 +40,6 @@ classifiers = [

[tool.poetry.dependencies]
python = ">=3.7,<3.14"
urllib3 = "<2"
sortedcontainers = ">=2"
defusedxml = ">=0.7"
splunk-sdk = ">=1.6"
Expand Down

0 comments on commit ecbb499

Please sign in to comment.