Skip to content

Commit 11ada60

Browse files
committed
Rewrite installation section in README
1 parent 37d5537 commit 11ada60

File tree

1 file changed

+5
-1
lines changed

1 file changed

+5
-1
lines changed

README.md

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -25,14 +25,18 @@ For more information, see the Splunk Enterprise [Installation Manual](https://do
2525

2626
### Installing the SDK
2727

28-
Refer to standard Python package installation methods.
28+
Using `pip` is the easiest way to pull the SDK into your project. `poetry` and `uv` should work just as well.
29+
30+
A project-specific virtualenv is recommended.
2931

3032
```sh
3133
python -m venv .venv
3234
source .venv/bin/activate
3335
python -m pip install splunk-sdk
3436
```
3537

38+
[See docs](https://dev.splunk.com/enterprise/docs/developapps/createapps/appanatomy/) for how to package additional dependencies with your app.
39+
3640
#### Optional: Create an `.env` file
3741

3842
To connect to Splunk Enterprise, many of the SDK examples and unit tests take command-line arguments that specify values for the host, port, and authentication. For convenience during development, you can store these arguments as key-value pairs in a `.env` file.

0 commit comments

Comments
 (0)