From 2436e690f15345ffa5c762df3c7817614afd0a4e Mon Sep 17 00:00:00 2001 From: ncanumalla-splunk <88208094+ncanumalla-splunk@users.noreply.github.com> Date: Wed, 8 Sep 2021 11:06:14 -0700 Subject: [PATCH 1/2] Update Readme steps to run examples This documentation updates is to address #353. --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 94ae4246..9986c170 100644 --- a/README.md +++ b/README.md @@ -114,7 +114,7 @@ Save the file as **.splunkrc** in the current user's home directory. #### Run the examples -Examples are located in the **/splunk-sdk-python/examples** directory. To run the examples at the command line, use the Python interpreter and include any arguments that are required by the example: +Examples are located in the **/splunk-sdk-python/examples** directory. To run the examples at the command line, use the Python interpreter and include any arguments that are required by the example. In the commands below, replace "examplename" with the name of the specific example in the directory that you want to run: python examplename.py --username="admin" --password="changeme" From a01ae70a7241089d21c233a2fa83a516d4bb44de Mon Sep 17 00:00:00 2001 From: ncanumalla-splunk <88208094+ncanumalla-splunk@users.noreply.github.com> Date: Wed, 6 Oct 2021 15:25:04 -0700 Subject: [PATCH 2/2] Remove usage of Easy_install to install SDK Easy_install is deprecated. This is to address https://github.com/splunk/splunk-sdk-python/issues/263 --- README.md | 6 +----- 1 file changed, 1 insertion(+), 5 deletions(-) diff --git a/README.md b/README.md index 9986c170..6b92a179 100644 --- a/README.md +++ b/README.md @@ -39,11 +39,7 @@ Here's what you need to get going with the Splunk Enterprise SDK for Python. ### Install the SDK -Use the following commands to install the Splunk Enterprise SDK for Python libraries in different ways. However, it's not necessary to install the libraries to run the examples and unit tests from the SDK. - -Use `easy_install`: - - [sudo] easy_install splunk-sdk +Use the following commands to install the Splunk Enterprise SDK for Python libraries. However, it's not necessary to install the libraries to run the examples and unit tests from the SDK. Use `pip`: