Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

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

Merged
merged 3 commits into from
Nov 28, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 16 additions & 0 deletions docs/release_6_0_0.md
Original file line number Diff line number Diff line change
@@ -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.
1 change: 1 addition & 0 deletions mkdocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
3 changes: 1 addition & 2 deletions poetry.lock

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 0 additions & 2 deletions pyproject.toml
Original file line number Diff line number Diff line change
Expand Up @@ -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"
Expand Down
Loading