From fec6e0d77d4a860f77342a11465e8c1b4bdd4cd3 Mon Sep 17 00:00:00 2001 From: "SPLUNKCORP\\apruneda" Date: Tue, 15 Sep 2020 17:25:24 -0700 Subject: [PATCH 01/18] edits --- README.md | 262 +++++++++++++++--------------------------------------- 1 file changed, 72 insertions(+), 190 deletions(-) diff --git a/README.md b/README.md index 3f429825e..91a6b64e0 100644 --- a/README.md +++ b/README.md @@ -5,98 +5,69 @@ #### Version 1.6.14 -The Splunk Software Development Kit (SDK) for Python contains library code and -examples designed to enable developers to build applications using Splunk. +The Splunk Software Development Kit (SDK) for Python contains library code and examples designed to enable developers to build applications using the Splunk platform. -Splunk is a search engine and analytic environment that uses a distributed -map-reduce architecture to efficiently index, search and process large -time-varying data sets. +Splunk is a search engine and analytic environment that uses a distributed map-reduce architecture to efficiently index, search, and process large time-varying data sets. -The Splunk product is popular with system administrators for aggregation and -monitoring of IT machine data, security, compliance and a wide variety of other -scenarios that share a requirement to efficiently index, search, analyze and -generate real-time notifications from large volumes of time series data. +The Splunk platform is popular with system administrators for aggregation and monitoring of IT machine data, security, compliance, and a wide variety of other scenarios that share a requirement to efficiently index, search, analyze, and generate real-time notifications from large volumes of time-series data. -The Splunk developer platform enables developers to take advantage of the same -technology used by the Splunk product to build exciting new applications that -are enabled by Splunk's unique capabilities. +The Splunk developer platform enables developers to take advantage of the same technology used by the Splunk platform to build exciting new applications. -## Getting started with the Splunk SDK for Python +## Get started with the Splunk SDK for Python -The Splunk SDK for Python contains library code and examples that show how to -programmatically interact with Splunk for a variety of scenarios including -searching, saved searches, data inputs, and many more, along with building -complete applications. +The Splunk SDK for Python contains library code and examples that show how to programmatically interact with Splunk for a variety of scenarios including searching, saved searches, data inputs, and many more, along with building complete applications. -The information in this Readme provides steps to get going quickly, but for more -in-depth information be sure to visit the -[Splunk Developer Portal](http://dev.splunk.com/view/SP-CAAAEBB). ### Requirements Here's what you need to get going with the Splunk SDK for Python. #### Python -The Splunk SDK for Python requires Python 2.7+, including Python 3. The Splunk SDK for Python has been tested with Python v2.7 and v3.5. +The Splunk SDK for Python requires Python 2.7+ and Python 3. The Splunk SDK for Python has been tested with Python v2.7 and v3.5. #### Splunk -If you haven't already installed Splunk, download it -[here](http://www.splunk.com/download). For more about installing and running -Splunk and system requirements, see -[Installing & Running Splunk](http://dev.splunk.com/view/SP-CAAADRV). The Splunk SDK for Python has been tested with Splunk Enterprise 7.0 and 7.2. +If you haven't already installed Splunk, download it [here](http://www.splunk.com/download). +For more information, see [System requirements for use of Splunk Enterprise on-premises](https://docs.splunk.com/Documentation/Splunk/latest/Installation/Systemrequirements) in the Splunk Enterprise _Installation Manual_. #### Splunk SDK for Python -Get the Splunk SDK for Python; [download the SDK as a ZIP](http://dev.splunk.com/view/SP-CAAAEBB) -and extract the files. Or, if you want to contribute to the SDK, clone the -repository from [GitHub](https://github.com/splunk/splunk-sdk-python). +Get the Splunk SDK for Python from [PyPI](https://pypi.org/project/splunk-sdk/). If you want to contribute to the SDK, clone the repository from [GitHub](https://github.com/splunk/splunk-sdk-python). -### Installing the SDK -You can install the Splunk SDK for Python libraries by using `easy_install` or `pip`: +### Install the SDK + +Use the following commands to install the Splunk 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 -Or +Use `pip`: [sudo] pip install splunk-sdk -Or to install the Python egg +Install the Python egg: [sudo] pip install --egg splunk-sdk -Alternatively, you can use **setup.py** on the sources you cloned from GitHub: +Install the sources you cloned from GitHub: [sudo] python setup.py install -However, it's not necessary to install the libraries to run the -examples and unit tests from the SDK. - -### Running the examples and unit tests +### Run the examples and unit tests -To run the examples and unit tests, you must put the root of -the SDK on your PYTHONPATH. For example, if you have downloaded the SDK to your -home folder and are running OS X or Linux, add the following line to your -**.bash_profile**: +To run the examples and unit tests, you must put the root of the SDK on your PYTHONPATH. For example, if you downloaded the SDK to your home folder and are running OS X or Linux, add the following line to your **.bash_profile** file: export PYTHONPATH=~/splunk-sdk-python -The SDK command-line examples require a common set of arguments -that specify things like the Splunk host, port, and login credentials. For a -full list of command-line arguments, include `--help` as an argument to any of -the examples. +The SDK command-line examples require a common set of arguments that specify the host, port, and login credentials for Splunk Enterprise. For a full list of command-line arguments, include `--help` as an argument to any of the examples. #### .splunkrc -To connect to Splunk, many of the SDK examples and unit tests take command-line -arguments that specify values for the host, port, and login credentials for -Splunk. For convenience during development, you can store these arguments as -key-value pairs in a text file named **.splunkrc**. Then, the SDK examples and -unit tests use the values from the **.splunkrc** file when you don't specify -them. +To connect to Splunk, many of the SDK examples and unit tests take command-line arguments that specify values for the host, port, and login credentials for Splunk Enterprise. For convenience during development, you can store these arguments as key-value pairs in a text file named **.splunkrc**. Then, the SDK examples and unit tests use the values from the **.splunkrc** file when you don't specify them. To use this convenience file, create a text file with the following format: @@ -110,8 +81,8 @@ To use this convenience file, create a text file with the following format: password=changeme # Access scheme (default: https) scheme=https - # Your version of Splunk (default: 5.0) - version=5.0 + # Your version of Splunk + version=8.0 Save the file as **.splunkrc** in the current user's home directory. @@ -123,32 +94,22 @@ Save the file as **.splunkrc** in the current user's home directory. C:\Users\currentusername\.splunkrc - You might get errors in Windows when you try to name the file because - ".splunkrc" looks like a nameless file with an extension. You can use - the command line to create this file—go to the - **C:\Users\currentusername** directory and enter the following command: + You might get errors in Windows when you try to name the file because ".splunkrc" appears to be a nameless file with an extension. You can use the command line to create this file by going to the **C:\Users\**_currentusername_ directory and entering the following command: Notepad.exe .splunkrc Click **Yes**, then continue creating the file. -**Note**: Storing login credentials in the **.splunkrc** file is only for -convenience during development. This file isn't part of the Splunk platform and -shouldn't be used for storing user credentials for production. And, if you're -at all concerned about the security of your credentials, just enter them at -the command line rather than saving them in this file. +**Note**: Storing login credentials in the **.splunkrc** file is only for convenience during development. This file isn't part of the Splunk platform and shouldn't be used for storing user credentials for production. And, if you're at all concerned about the security of your credentials, enter them at the command line rather than saving them in this file. #### 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: python examplename.py --username="admin" --password="changeme" -If you saved your login credentials in the **.splunkrc** file, you can omit -those arguments: +If you saved your login credentials in the **.splunkrc** file, you can omit those arguments: python examplename.py @@ -158,172 +119,93 @@ To get help for an example, use the `--help` argument with an example: #### Unit tests -The Splunk SDK for Python contains a collection of unit tests. To run them, open a -command prompt in the **/splunk-sdk-python** directory and enter: +The Splunk SDK for Python contains a collection of unit tests. To run them, open a command prompt in the **/splunk-sdk-python** directory and enter: make -You can also run individual test files, which are located in -**/splunk-sdk-python/tests**. The following command explains how to run -a specific test: +You can also run individual test files, which are located in **/splunk-sdk-python/tests**. To run a specific test, enter: - make test_specific + make specific_test_name -The test suite uses Python's standard library, the built-in `unittest` -library, `pytest`, and `tox`. +The test suite uses Python's standard library, the built-in `unittest` library, `pytest`, and `tox`. -**Important Notes:** +**Notes:** -The test run will fail unless the -[SDK App Collection](https://github.com/splunk/sdk-app-collection) is installed. +The test run fails unless the [SDK App Collection](https://github.com/splunk/sdk-app-collection) app is installed. -You can exclude app-specific tests with the following command: +To exclude app-specific tests, use the following command: make test_no_app -You can read more about our testing framework on -[GitHub](https://github.com/splunk/splunk-sdk-python/tree/master/tests). +To learn about our testing framework, see [Splunk Test Suite](https://github.com/splunk/splunk-sdk-python/tree/master/tests) on GitHub. -In addition, the test run requires the searchcommands app to be built. The `make` -command runs the tasks to do this, but more complex testing may require you to -rebuild using `make build_app`. +In addition, the test run requires you to build the searchcommands app. The `make` command runs the tasks to do this, but more complex testing may require you to rebuild using the `make build_app` command. ## Repository - - - - - - - - - - - - - - - - - - - - - - - - - - - -
/docsSource for Sphinx-based docs and build
/examplesExamples demonstrating various SDK features
/splunklibSource for the Splunk library modules
/testsSource for unit tests
/utilsSource for utilities shared by the examples and unit tests
+| Directory | Description | +|:--------- |:---------------------------------------------------------- | +|/docs | Source for Sphinx-based docs and build | +|/examples | Examples demonstrating various SDK features | +|/splunklib | Source for the Splunk library modules | +|/tests | Source for unit tests | +|/utils | Source for utilities shared by the examples and unit tests | ### Changelog -The **CHANGELOG.md** file in the root of the repository contains a description -of changes for each version of the SDK. You can also find it online at -[https://github.com/splunk/splunk-sdk-python/blob/master/CHANGELOG.md](https://github.com/splunk/splunk-sdk-python/blob/master/CHANGELOG.md). +The CHANGELOG.md file in the root of this repository contains a description +of changes for each version of the SDK. For the latest version, see the [CHANGELOG.md](https://github.com/splunk/splunk-sdk-python/blob/master/CHANGELOG.md) on GitHub. ### Branches -The **master** branch always represents a stable and released version of the SDK. -You can read more about our branching model on our Wiki at -[https://github.com/splunk/splunk-sdk-python/wiki/Branching-Model](https://github.com/splunk/splunk-sdk-python/wiki/Branching-Model). +The **master** branch represents a stable and released version of the SDK. +To learn about our branching model, see [Branching Model](https://github.com/splunk/splunk-sdk-python/wiki/Branching-Model) on GitHub. ## Documentation and resources -If you need to know more: - -* For all things developer with Splunk, your main resource is the - [Splunk Developer Portal](http://dev.splunk.com). - -* For conceptual and how-to documentation, see the - [Overview of the Splunk SDK for Python](http://dev.splunk.com/view/SP-CAAAEBB). - -* For API reference documentation, see the - [Splunk SDK for Python Reference](http://docs.splunk.com/Documentation/PythonSDK). -* For more about the Splunk REST API, see the - [REST API Reference](http://docs.splunk.com/Documentation/Splunk/latest/RESTAPI). +| Resource | Description | +|:----------------------- |:----------- | +| [Splunk Developer Portal](http://dev.splunk.com) | General developer documentation, tools, and examples | +| [Integrate the Splunk platform using development tools for Python](https://dev.splunk.com/enterprise/docs/devtools/python)| Documentation for Python development | +| [Splunk SDK for Python Reference](http://docs.splunk.com/Documentation/PythonSDK) | SDK API reference documentation | +| [REST API Reference Manual](https://docs.splunk.com/Documentation/Splunk/latest/RESTREF/RESTprolog) | Splunk REST API reference documentation | +| [Splunk>Docs](https://docs.splunk.com/Documentation) | General documentation for the Splunk platform | +| [GitHub Wiki](https://github.com/splunk/splunk-sdk-python/wiki/) | Documentation for this SDK's repository on GitHub | -* For more about about Splunk in general, see - [Splunk>Docs](http://docs.splunk.com/Documentation/Splunk). - -* For more about this SDK's repository, see our - [GitHub Wiki](https://github.com/splunk/splunk-sdk-python/wiki/). ## Community -Stay connected with other developers building on Splunk. - - - - - - - +Stay connected with other developers building on the Splunk platform. - - - +* [Email](mailto:devinfo@splunk.com) +* [Issues and pull requests](https://github.com/splunk/splunk-sdk-python/issues/) +* [Community Slack](https://splunk-usergroups.slack.com/app_redirect?channel=appdev) +* [Splunk Answers](https://community.splunk.com/t5/Splunk-Development/ct-p/developer-tools) +* [Splunk Blogs](https://www.splunk.com/blog) +* [Twitter](https://twitter.com/splunkdev) - - - - - - - - - - - +### How to contribute -
Emaildevinfo@splunk.com
Issues -https://github.com/splunk/splunk-sdk-python/issues/
Answers -http://splunk-base.splunk.com/tags/python/
Blog -http://blogs.splunk.com/dev/
Twitter -@splunkdev
+If you would like to contribute to the SDK, see [Contributions to Splunk](https://www.splunk.com/en_us/form/contributions.html). -### How to contribute +### Support -If you would like to contribute to the SDK, go here for more information: +1. You will be granted support if you or your company are already covered under an existing maintenance/support agreement. -* [Splunk and open source](http://dev.splunk.com/view/opensource/SP-CAAAEDM) + Submit a new case in the [Support Portal](https://www.splunk.com/en_us/support-and-services.html)) and include "Splunk SDK for Python" in the subject line. -* [Individual contributions](http://dev.splunk.com/goto/individualcontributions) +2. If you are not covered under an existing maintenance/support agreement, you can find help through the broader community at [Splunk Answers](https://community.splunk.com/t5/Splunk-Development/ct-p/developer-tools). -* [Company contributions](http://dev.splunk.com/view/companycontributions/SP-CAAAEDR) +3. Splunk will NOT provide support for SDKs if the core library (the code in the /splunklib directory) has been modified. If you modify an SDK and want support, you can find help through the broader community and [Splunk Answers](https://community.splunk.com/t5/Splunk-Development/ct-p/developer-tools). -### Support + We would also like to know why you modified the core library, so please send feedback to _devinfo@splunk.com_. -1. You will be granted support if you or your company are already covered - under an existing maintenance/support agreement. - Submit a new case in the [Support Portal][contact] and include "Splunk SDK for Python" - in the subject line. -2. If you are not covered under an existing maintenance/support agreement, you - can find help through the broader community at: - -3. Splunk will NOT provide support for SDKs if the core library (the - code in the /splunklib directory) has been modified. If you modify an - SDK and want support, you can find help through the broader community and - Splunk answers (see above). We would also like to know why you modified the - core library—please send feedback to devinfo@splunk.com. 4. File any issues on [GitHub](https://github.com/splunk/splunk-sdk-python/issues). ### Contact Us -You can [contact support][contact] if you have Splunk related questions. - You can reach the Developer Platform team at _devinfo@splunk.com_. ## License -The Splunk Software Development Kit for Python is licensed under the Apache -License 2.0. Details can be found in the file LICENSE. - -[contact]: https://www.splunk.com/en_us/support-and-services.html +The Splunk Software Development Kit for Python is licensed under the Apache License 2.0. Details can be found in the file LICENSE. From 60bdea0baf83ecc6732a2a8dd72ce2992e14090e Mon Sep 17 00:00:00 2001 From: "SPLUNKCORP\\apruneda" Date: Tue, 15 Sep 2020 17:31:46 -0700 Subject: [PATCH 02/18] edits --- README.md | 21 +++++++++------------ 1 file changed, 9 insertions(+), 12 deletions(-) diff --git a/README.md b/README.md index 91a6b64e0..b34114d7e 100644 --- a/README.md +++ b/README.md @@ -94,7 +94,7 @@ Save the file as **.splunkrc** in the current user's home directory. C:\Users\currentusername\.splunkrc - You might get errors in Windows when you try to name the file because ".splunkrc" appears to be a nameless file with an extension. You can use the command line to create this file by going to the **C:\Users\**_currentusername_ directory and entering the following command: + You might get errors in Windows when you try to name the file because ".splunkrc" appears to be a nameless file with an extension. You can use the command line to create this file by going to the **C:\Users\***currentusername* directory and entering the following command: Notepad.exe .splunkrc @@ -131,15 +131,14 @@ The test suite uses Python's standard library, the built-in `unittest` library, **Notes:** -The test run fails unless the [SDK App Collection](https://github.com/splunk/sdk-app-collection) app is installed. - -To exclude app-specific tests, use the following command: +* The test run fails unless the [SDK App Collection](https://github.com/splunk/sdk-app-collection) app is installed. +* To exclude app-specific tests, use the following command: make test_no_app -To learn about our testing framework, see [Splunk Test Suite](https://github.com/splunk/splunk-sdk-python/tree/master/tests) on GitHub. +* To learn about our testing framework, see [Splunk Test Suite](https://github.com/splunk/splunk-sdk-python/tree/master/tests) on GitHub. -In addition, the test run requires you to build the searchcommands app. The `make` command runs the tasks to do this, but more complex testing may require you to rebuild using the `make build_app` command. + In addition, the test run requires you to build the searchcommands app. The `make` command runs the tasks to do this, but more complex testing may require you to rebuild using the `make build_app` command. ## Repository @@ -190,17 +189,15 @@ If you would like to contribute to the SDK, see [Contributions to Splunk](https: ### Support -1. You will be granted support if you or your company are already covered under an existing maintenance/support agreement. - - Submit a new case in the [Support Portal](https://www.splunk.com/en_us/support-and-services.html)) and include "Splunk SDK for Python" in the subject line. +* You will be granted support if you or your company are already covered under an existing maintenance/support agreement. Submit a new case in the [Support Portal](https://www.splunk.com/en_us/support-and-services.html)) and include "Splunk SDK for Python" in the subject line. -2. If you are not covered under an existing maintenance/support agreement, you can find help through the broader community at [Splunk Answers](https://community.splunk.com/t5/Splunk-Development/ct-p/developer-tools). + If you are not covered under an existing maintenance/support agreement, you can find help through the broader community at [Splunk Answers](https://community.splunk.com/t5/Splunk-Development/ct-p/developer-tools). -3. Splunk will NOT provide support for SDKs if the core library (the code in the /splunklib directory) has been modified. If you modify an SDK and want support, you can find help through the broader community and [Splunk Answers](https://community.splunk.com/t5/Splunk-Development/ct-p/developer-tools). +* Splunk will NOT provide support for SDKs if the core library (the code in the /splunklib directory) has been modified. If you modify an SDK and want support, you can find help through the broader community and [Splunk Answers](https://community.splunk.com/t5/Splunk-Development/ct-p/developer-tools). We would also like to know why you modified the core library, so please send feedback to _devinfo@splunk.com_. -4. File any issues on [GitHub](https://github.com/splunk/splunk-sdk-python/issues). +* File any issues on [GitHub](https://github.com/splunk/splunk-sdk-python/issues). ### Contact Us From 0f059b305b6a99f0c2bef2fecb18eee3c8abee67 Mon Sep 17 00:00:00 2001 From: "SPLUNKCORP\\apruneda" Date: Tue, 15 Sep 2020 17:37:52 -0700 Subject: [PATCH 03/18] edits --- README.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index b34114d7e..f1dcae725 100644 --- a/README.md +++ b/README.md @@ -94,7 +94,7 @@ Save the file as **.splunkrc** in the current user's home directory. C:\Users\currentusername\.splunkrc - You might get errors in Windows when you try to name the file because ".splunkrc" appears to be a nameless file with an extension. You can use the command line to create this file by going to the **C:\Users\***currentusername* directory and entering the following command: + You might get errors in Windows when you try to name the file because ".splunkrc" appears to be a nameless file with an extension. You can use the command line to create this file by going to the **C:\Users\ Date: Tue, 15 Sep 2020 17:41:42 -0700 Subject: [PATCH 04/18] edits --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index f1dcae725..85bd53598 100644 --- a/README.md +++ b/README.md @@ -205,4 +205,4 @@ You can reach the Developer Platform team at _devinfo@splunk.com_. ## License -The Splunk Software Development Kit for Python is licensed under the Apache License 2.0. See the LICENSE file for details. +The Splunk Software Development Kit for Python is licensed under the Apache License 2.0. See [LICENSE](LICENSE) for details. From 53dd5d681dc8e34fb817ec48efc34a8a9ccc49c2 Mon Sep 17 00:00:00 2001 From: "SPLUNKCORP\\apruneda" Date: Wed, 16 Sep 2020 11:22:37 -0700 Subject: [PATCH 05/18] edits --- README.md | 12 ++++++------ 1 file changed, 6 insertions(+), 6 deletions(-) diff --git a/README.md b/README.md index 85bd53598..f71104adc 100644 --- a/README.md +++ b/README.md @@ -7,7 +7,7 @@ The Splunk Software Development Kit (SDK) for Python contains library code and examples designed to enable developers to build applications using the Splunk platform. -Splunk is a search engine and analytic environment that uses a distributed map-reduce architecture to efficiently index, search, and process large time-varying data sets. +The Splunk platform is a search engine and analytic environment that uses a distributed map-reduce architecture to efficiently index, search, and process large time-varying data sets. The Splunk platform is popular with system administrators for aggregation and monitoring of IT machine data, security, compliance, and a wide variety of other scenarios that share a requirement to efficiently index, search, analyze, and generate real-time notifications from large volumes of time-series data. @@ -16,7 +16,7 @@ The Splunk developer platform enables developers to take advantage of the same t ## Get started with the Splunk SDK for Python -The Splunk SDK for Python contains library code and examples that show how to programmatically interact with Splunk for a variety of scenarios including searching, saved searches, data inputs, and many more, along with building complete applications. +The Splunk SDK for Python contains library code and examples that show how to programmatically interact with the Splunk platform for a variety of scenarios including searching, saved searches, data inputs, and many more, along with building complete applications. ### Requirements @@ -29,7 +29,7 @@ The Splunk SDK for Python requires Python 2.7+ and Python 3. The Splunk SDK for #### Splunk If you haven't already installed Splunk, download it [here](http://www.splunk.com/download). -For more information, see [System requirements for use of Splunk Enterprise on-premises](https://docs.splunk.com/Documentation/Splunk/latest/Installation/Systemrequirements) in the Splunk Enterprise _Installation Manual_. +For more information, see the Splunk Enterprise [Installation Manual](https://docs.splunk.com/Documentation/Splunk/latest/Installation). #### Splunk SDK for Python @@ -65,9 +65,9 @@ To run the examples and unit tests, you must put the root of the SDK on your PYT The SDK command-line examples require a common set of arguments that specify the host, port, and login credentials for Splunk Enterprise. For a full list of command-line arguments, include `--help` as an argument to any of the examples. -#### .splunkrc +#### Convenience file (.splunkrc) -To connect to Splunk, many of the SDK examples and unit tests take command-line arguments that specify values for the host, port, and login credentials for Splunk Enterprise. For convenience during development, you can store these arguments as key-value pairs in a text file named **.splunkrc**. Then, the SDK examples and unit tests use the values from the **.splunkrc** file when you don't specify them. +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 login credentials for Splunk Enterprise. For convenience during development, you can store these arguments as key-value pairs in a text file named **.splunkrc**. Then, the SDK examples and unit tests use the values from the **.splunkrc** file when you don't specify them. To use this convenience file, create a text file with the following format: @@ -201,7 +201,7 @@ If you would like to contribute to the SDK, see [Contributions to Splunk](https: ### Contact Us -You can reach the Developer Platform team at _devinfo@splunk.com_. +You can reach the Splunk Developer Platform team at _devinfo@splunk.com_. ## License From c4ef7c4812ece7e8d26f7b74339d4f4ee03c75a6 Mon Sep 17 00:00:00 2001 From: "SPLUNKCORP\\apruneda" Date: Wed, 16 Sep 2020 11:47:27 -0700 Subject: [PATCH 06/18] edits --- README.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/README.md b/README.md index f71104adc..ac9b743ee 100644 --- a/README.md +++ b/README.md @@ -13,6 +13,8 @@ The Splunk platform is popular with system administrators for aggregation and mo The Splunk developer platform enables developers to take advantage of the same technology used by the Splunk platform to build exciting new applications. +For more information, see [Splunk Enterprise SDK for Python](https://dev.splunk.com/enterprise/docs/devtools/python/sdk-python/) on the Splunk Developer Portal. + ## Get started with the Splunk SDK for Python From e5714caf86309893edc201286feb77ca22d11da7 Mon Sep 17 00:00:00 2001 From: "SPLUNKCORP\\apruneda" Date: Wed, 16 Sep 2020 11:58:25 -0700 Subject: [PATCH 07/18] edits --- README.md | 46 ++++++++++++++++++++++------------------------ 1 file changed, 22 insertions(+), 24 deletions(-) diff --git a/README.md b/README.md index ac9b743ee..4b8e837e8 100644 --- a/README.md +++ b/README.md @@ -24,18 +24,18 @@ The Splunk SDK for Python contains library code and examples that show how to pr Here's what you need to get going with the Splunk SDK for Python. -#### Python +* Python -The Splunk SDK for Python requires Python 2.7+ and Python 3. The Splunk SDK for Python has been tested with Python v2.7 and v3.5. + The Splunk SDK for Python requires Python 2.7+ and Python 3. The Splunk SDK for Python has been tested with Python v2.7 and v3.5. -#### Splunk +* Splunk -If you haven't already installed Splunk, download it [here](http://www.splunk.com/download). -For more information, see the Splunk Enterprise [Installation Manual](https://docs.splunk.com/Documentation/Splunk/latest/Installation). + If you haven't already installed Splunk, download it [here](http://www.splunk.com/download). + For more information, see the Splunk Enterprise [_Installation Manual_](https://docs.splunk.com/Documentation/Splunk/latest/Installation). -#### Splunk SDK for Python +* Splunk SDK for Python -Get the Splunk SDK for Python from [PyPI](https://pypi.org/project/splunk-sdk/). If you want to contribute to the SDK, clone the repository from [GitHub](https://github.com/splunk/splunk-sdk-python). + Get the Splunk SDK for Python from [PyPI](https://pypi.org/project/splunk-sdk/). If you want to contribute to the SDK, clone the repository from [GitHub](https://github.com/splunk/splunk-sdk-python). ### Install the SDK @@ -67,10 +67,12 @@ To run the examples and unit tests, you must put the root of the SDK on your PYT The SDK command-line examples require a common set of arguments that specify the host, port, and login credentials for Splunk Enterprise. For a full list of command-line arguments, include `--help` as an argument to any of the examples. -#### Convenience file (.splunkrc) +#### Create a .splunkrc convenience file 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 login credentials for Splunk Enterprise. For convenience during development, you can store these arguments as key-value pairs in a text file named **.splunkrc**. Then, the SDK examples and unit tests use the values from the **.splunkrc** file when you don't specify them. +>**Note**: Storing login credentials in the **.splunkrc** file is only for convenience during development. This file isn't part of the Splunk platform and shouldn't be used for storing user credentials for production. And, if you're at all concerned about the security of your credentials, enter them at the command line rather than saving them in this file. + To use this convenience file, create a text file with the following format: # Splunk host (default: localhost) @@ -102,10 +104,7 @@ Save the file as **.splunkrc** in the current user's home directory. Click **Yes**, then continue creating the file. -**Note**: Storing login credentials in the **.splunkrc** file is only for convenience during development. This file isn't part of the Splunk platform and shouldn't be used for storing user credentials for production. And, if you're at all concerned about the security of your credentials, enter them at the command line rather than saving them in this file. - - -#### Examples +#### 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: @@ -119,7 +118,7 @@ To get help for an example, use the `--help` argument with an example: python examplename.py --help -#### Unit tests +#### Run the unit tests The Splunk SDK for Python contains a collection of unit tests. To run them, open a command prompt in the **/splunk-sdk-python** directory and enter: @@ -131,16 +130,15 @@ You can also run individual test files, which are located in **/splunk-sdk-pytho The test suite uses Python's standard library, the built-in `unittest` library, `pytest`, and `tox`. -**Notes:** - -* The test run fails unless the [SDK App Collection](https://github.com/splunk/sdk-app-collection) app is installed. -* To exclude app-specific tests, use the following command: - - make test_no_app - -* To learn about our testing framework, see [Splunk Test Suite](https://github.com/splunk/splunk-sdk-python/tree/master/tests) on GitHub. - - In addition, the test run requires you to build the searchcommands app. The `make` command runs the tasks to do this, but more complex testing may require you to rebuild using the `make build_app` command. +>**Notes:** +>* The test run fails unless the [SDK App Collection](https://github.com/splunk/sdk-app-collection) app is installed. +>* To exclude app-specific tests, use the following command: +> +> make test_no_app +> +>* To learn about our testing framework, see [Splunk Test Suite](https://github.com/splunk/splunk-sdk-python/tree/master/tests) on GitHub. +> +> In addition, the test run requires you to build the searchcommands app. The `make` command runs the tasks to do this, but more complex testing may require you to rebuild using the `make build_app` command. ## Repository @@ -185,7 +183,7 @@ Stay connected with other developers building on the Splunk platform. * [Splunk Blogs](https://www.splunk.com/blog) * [Twitter](https://twitter.com/splunkdev) -### How to contribute +### Contribute If you would like to contribute to the SDK, see [Contributions to Splunk](https://www.splunk.com/en_us/form/contributions.html). From 27d14d9a8c7c38800e2824316fa4216ef7988753 Mon Sep 17 00:00:00 2001 From: "SPLUNKCORP\\apruneda" Date: Wed, 16 Sep 2020 12:05:16 -0700 Subject: [PATCH 08/18] edits --- README.md | 7 +++---- 1 file changed, 3 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index 4b8e837e8..748bbeeb6 100644 --- a/README.md +++ b/README.md @@ -134,7 +134,7 @@ The test suite uses Python's standard library, the built-in `unittest` library, >* The test run fails unless the [SDK App Collection](https://github.com/splunk/sdk-app-collection) app is installed. >* To exclude app-specific tests, use the following command: > -> make test_no_app +> `make test_no_app` > >* To learn about our testing framework, see [Splunk Test Suite](https://github.com/splunk/splunk-sdk-python/tree/master/tests) on GitHub. > @@ -152,8 +152,7 @@ The test suite uses Python's standard library, the built-in `unittest` library, ### Changelog -The CHANGELOG.md file in the root of this repository contains a description -of changes for each version of the SDK. For the latest version, see the [CHANGELOG.md](https://github.com/splunk/splunk-sdk-python/blob/master/CHANGELOG.md) on GitHub. +The [CHANGELOG](CHANGELOG) contains a description of changes for each version of the SDK. For the latest version, see the [CHANGELOG.md](https://github.com/splunk/splunk-sdk-python/blob/master/CHANGELOG.md) on GitHub. ### Branches @@ -189,7 +188,7 @@ If you would like to contribute to the SDK, see [Contributions to Splunk](https: ### Support -* You will be granted support if you or your company are already covered under an existing maintenance/support agreement. Submit a new case in the [Support Portal](https://www.splunk.com/en_us/support-and-services.html)) and include "Splunk SDK for Python" in the subject line. +* You will be granted support if you or your company are already covered under an existing maintenance/support agreement. Submit a new case in the [Support Portal](https://www.splunk.com/en_us/support-and-services.html) and include "Splunk SDK for Python" in the subject line. If you are not covered under an existing maintenance/support agreement, you can find help through the broader community at [Splunk Answers](https://community.splunk.com/t5/Splunk-Development/ct-p/developer-tools). From 15c55c619d244fdac958e39c276e412d6d27ddb6 Mon Sep 17 00:00:00 2001 From: "SPLUNKCORP\\apruneda" Date: Wed, 16 Sep 2020 12:07:54 -0700 Subject: [PATCH 09/18] edits --- README.md | 10 +++------- 1 file changed, 3 insertions(+), 7 deletions(-) diff --git a/README.md b/README.md index 748bbeeb6..ab9534f2f 100644 --- a/README.md +++ b/README.md @@ -132,13 +132,9 @@ The test suite uses Python's standard library, the built-in `unittest` library, >**Notes:** >* The test run fails unless the [SDK App Collection](https://github.com/splunk/sdk-app-collection) app is installed. ->* To exclude app-specific tests, use the following command: -> -> `make test_no_app` -> +>* To exclude app-specific tests, use the following command: `make test_no_app` >* To learn about our testing framework, see [Splunk Test Suite](https://github.com/splunk/splunk-sdk-python/tree/master/tests) on GitHub. -> -> In addition, the test run requires you to build the searchcommands app. The `make` command runs the tasks to do this, but more complex testing may require you to rebuild using the `make build_app` command. +> In addition, the test run requires you to build the searchcommands app. The `make` command runs the tasks to do this, but more complex testing may require you to rebuild using the `make build_app` command. ## Repository @@ -152,7 +148,7 @@ The test suite uses Python's standard library, the built-in `unittest` library, ### Changelog -The [CHANGELOG](CHANGELOG) contains a description of changes for each version of the SDK. For the latest version, see the [CHANGELOG.md](https://github.com/splunk/splunk-sdk-python/blob/master/CHANGELOG.md) on GitHub. +The [CHANGELOG](CHANGELOG.md) contains a description of changes for each version of the SDK. For the latest version, see the [CHANGELOG.md](https://github.com/splunk/splunk-sdk-python/blob/master/CHANGELOG.md) on GitHub. ### Branches From 48918d6d9c75af3e33a4ca468d846849d3f0b918 Mon Sep 17 00:00:00 2001 From: "SPLUNKCORP\\apruneda" Date: Wed, 16 Sep 2020 12:11:11 -0700 Subject: [PATCH 10/18] edits --- README.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index ab9534f2f..544b34084 100644 --- a/README.md +++ b/README.md @@ -98,7 +98,7 @@ Save the file as **.splunkrc** in the current user's home directory. C:\Users\currentusername\.splunkrc - You might get errors in Windows when you try to name the file because ".splunkrc" appears to be a nameless file with an extension. You can use the command line to create this file by going to the **C:\Users\** directory and entering the following command: Notepad.exe .splunkrc @@ -132,7 +132,7 @@ The test suite uses Python's standard library, the built-in `unittest` library, >**Notes:** >* The test run fails unless the [SDK App Collection](https://github.com/splunk/sdk-app-collection) app is installed. ->* To exclude app-specific tests, use the following command: `make test_no_app` +>* To exclude app-specific tests, use the `make test_no_app` command. >* To learn about our testing framework, see [Splunk Test Suite](https://github.com/splunk/splunk-sdk-python/tree/master/tests) on GitHub. > In addition, the test run requires you to build the searchcommands app. The `make` command runs the tasks to do this, but more complex testing may require you to rebuild using the `make build_app` command. From 623f1abee629fa329dee1211afb252dfd724ec01 Mon Sep 17 00:00:00 2001 From: "SPLUNKCORP\\apruneda" Date: Wed, 16 Sep 2020 12:13:03 -0700 Subject: [PATCH 11/18] edits --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 544b34084..87d579ac6 100644 --- a/README.md +++ b/README.md @@ -178,7 +178,7 @@ Stay connected with other developers building on the Splunk platform. * [Splunk Blogs](https://www.splunk.com/blog) * [Twitter](https://twitter.com/splunkdev) -### Contribute +### Contributions If you would like to contribute to the SDK, see [Contributions to Splunk](https://www.splunk.com/en_us/form/contributions.html). From 804415375eb272a59dce84296b730ef33e3183fc Mon Sep 17 00:00:00 2001 From: "SPLUNKCORP\\apruneda" Date: Wed, 16 Sep 2020 12:53:07 -0700 Subject: [PATCH 12/18] edits --- README.md | 34 +++++++++++++++++----------------- 1 file changed, 17 insertions(+), 17 deletions(-) diff --git a/README.md b/README.md index 87d579ac6..d772e1b84 100644 --- a/README.md +++ b/README.md @@ -1,11 +1,11 @@ [![Build Status](https://travis-ci.org/splunk/splunk-sdk-python.svg?branch=master)](https://travis-ci.org/splunk/splunk-sdk-python) [![Documentation Status](https://readthedocs.org/projects/splunk-python-sdk/badge/?version=latest)](https://splunk-python-sdk.readthedocs.io/en/latest/?badge=latest) -# The Splunk Software Development Kit for Python +# The Splunk Enterprise Software Development Kit for Python #### Version 1.6.14 -The Splunk Software Development Kit (SDK) for Python contains library code and examples designed to enable developers to build applications using the Splunk platform. +The Splunk Enterprise Software Development Kit (SDK) for Python contains library code and examples designed to enable developers to build applications using the Splunk platform. The Splunk platform is a search engine and analytic environment that uses a distributed map-reduce architecture to efficiently index, search, and process large time-varying data sets. @@ -16,31 +16,31 @@ The Splunk developer platform enables developers to take advantage of the same t For more information, see [Splunk Enterprise SDK for Python](https://dev.splunk.com/enterprise/docs/devtools/python/sdk-python/) on the Splunk Developer Portal. -## Get started with the Splunk SDK for Python +## Get started with the Splunk Enterprise SDK for Python -The Splunk SDK for Python contains library code and examples that show how to programmatically interact with the Splunk platform for a variety of scenarios including searching, saved searches, data inputs, and many more, along with building complete applications. +The Splunk Enterprise SDK for Python contains library code and examples that show how to programmatically interact with the Splunk platform for a variety of scenarios including searching, saved searches, data inputs, and many more, along with building complete applications. ### Requirements -Here's what you need to get going with the Splunk SDK for Python. +Here's what you need to get going with the Splunk Enterprise SDK for Python. -* Python +* Python 2.7+ and Python 3. + + The Splunk Enterprise SDK for Python has been tested with Python v2.7 and v3.5. - The Splunk SDK for Python requires Python 2.7+ and Python 3. The Splunk SDK for Python has been tested with Python v2.7 and v3.5. +* Splunk Enterprise -* Splunk - - If you haven't already installed Splunk, download it [here](http://www.splunk.com/download). + If you haven't already installed Splunk Enterprise, download it [here](http://www.splunk.com/download). For more information, see the Splunk Enterprise [_Installation Manual_](https://docs.splunk.com/Documentation/Splunk/latest/Installation). -* Splunk SDK for Python +* Splunk Enterprise SDK for Python - Get the Splunk SDK for Python from [PyPI](https://pypi.org/project/splunk-sdk/). If you want to contribute to the SDK, clone the repository from [GitHub](https://github.com/splunk/splunk-sdk-python). + Get the Splunk Enterprise SDK for Python from [PyPI](https://pypi.org/project/splunk-sdk/). If you want to contribute to the SDK, clone the repository from [GitHub](https://github.com/splunk/splunk-sdk-python). ### Install the SDK -Use the following commands to install the Splunk 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 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`: @@ -120,7 +120,7 @@ To get help for an example, use the `--help` argument with an example: #### Run the unit tests -The Splunk SDK for Python contains a collection of unit tests. To run them, open a command prompt in the **/splunk-sdk-python** directory and enter: +The Splunk Enterprise SDK for Python contains a collection of unit tests. To run them, open a command prompt in the **/splunk-sdk-python** directory and enter: make @@ -161,7 +161,7 @@ To learn about our branching model, see [Branching Model](https://github.com/spl |:----------------------- |:----------- | | [Splunk Developer Portal](http://dev.splunk.com) | General developer documentation, tools, and examples | | [Integrate the Splunk platform using development tools for Python](https://dev.splunk.com/enterprise/docs/devtools/python)| Documentation for Python development | -| [Splunk SDK for Python Reference](http://docs.splunk.com/Documentation/PythonSDK) | SDK API reference documentation | +| [Splunk Enterprise SDK for Python Reference](http://docs.splunk.com/Documentation/PythonSDK) | SDK API reference documentation | | [REST API Reference Manual](https://docs.splunk.com/Documentation/Splunk/latest/RESTREF/RESTprolog) | Splunk REST API reference documentation | | [Splunk>Docs](https://docs.splunk.com/Documentation) | General documentation for the Splunk platform | | [GitHub Wiki](https://github.com/splunk/splunk-sdk-python/wiki/) | Documentation for this SDK's repository on GitHub | @@ -184,7 +184,7 @@ If you would like to contribute to the SDK, see [Contributions to Splunk](https: ### Support -* You will be granted support if you or your company are already covered under an existing maintenance/support agreement. Submit a new case in the [Support Portal](https://www.splunk.com/en_us/support-and-services.html) and include "Splunk SDK for Python" in the subject line. +* You will be granted support if you or your company are already covered under an existing maintenance/support agreement. Submit a new case in the [Support Portal](https://www.splunk.com/en_us/support-and-services.html) and include "Splunk Enterprise SDK for Python" in the subject line. If you are not covered under an existing maintenance/support agreement, you can find help through the broader community at [Splunk Answers](https://community.splunk.com/t5/Splunk-Development/ct-p/developer-tools). @@ -200,4 +200,4 @@ You can reach the Splunk Developer Platform team at _devinfo@splunk.com_. ## License -The Splunk Software Development Kit for Python is licensed under the Apache License 2.0. See [LICENSE](LICENSE) for details. +The Splunk Enterprise Software Development Kit for Python is licensed under the Apache License 2.0. See [LICENSE](LICENSE) for details. From 4bd19b8c153c509f36d63bac29c526fd85231e81 Mon Sep 17 00:00:00 2001 From: "SPLUNKCORP\\apruneda" Date: Wed, 16 Sep 2020 16:16:46 -0700 Subject: [PATCH 13/18] edits --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index d772e1b84..bf5f60d09 100644 --- a/README.md +++ b/README.md @@ -98,7 +98,7 @@ Save the file as **.splunkrc** in the current user's home directory. C:\Users\currentusername\.splunkrc - You might get errors in Windows when you try to name the file because ".splunkrc" appears to be a nameless file with an extension. You can use the command line to create this file by going to the **C:\Users\** directory and entering the following command: + You might get errors in Windows when you try to name the file because ".splunkrc" appears to be a nameless file with an extension. You can use the command line to create this file by going to the **C:\Users\\<currentusername>** directory and entering the following command: Notepad.exe .splunkrc From e2d7717cd8a5f9b0c45524d6b6ced1e5febb8dd2 Mon Sep 17 00:00:00 2001 From: "SPLUNKCORP\\apruneda" Date: Wed, 16 Sep 2020 17:00:47 -0700 Subject: [PATCH 14/18] Updates --- CHANGELOG.md | 6 +++--- CONTRIBUTING.md | 36 ++++++++++++++---------------------- README.md | 2 +- 3 files changed, 18 insertions(+), 26 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 45f88f519..6934cee08 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,4 +1,4 @@ -# Splunk SDK for Python Changelog +# Splunk Enterprise SDK for Python Changelog ## Version 1.6.14 @@ -51,9 +51,9 @@ ### Changes -* Updated the Splunk SDK for Python to work with the Python 3 version of Splunk Enterprise on Windows +* Updated the Splunk Enterprise SDK for Python to work with the Python 3 version of Splunk Enterprise on Windows * Improved the performance of deleting/updating an input -* Added logging to custom search commands app to showcase how to do logging in custom search commands by using the Splunk SDK for Python +* Added logging to custom search commands app to showcase how to do logging in custom search commands by using the Splunk Enterprise SDK for Python ## Version 1.6.6 diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 36511355a..8c8eccd87 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -2,19 +2,19 @@ ## How to contribute -If you would like to contribute to this project, see [Contributions to Splunk][indivcontrib] for more information. +If you would like to contribute to this project, see [Contributions to Splunk][https://www.splunk.com/en_us/form/contributions.html] for more information. -## Issues & Bug Reports +## Issues and bug reports -If you're seeing some unexpected behavior with this project, please create an [issue on GitHub][issues] with the following information: +If you're seeing some unexpected behavior with this project, please create an [issue](https://github.com/splunk/splunk-sdk-python/issues) on GitHub with the following information: 1. Version of this project you're using (ex: 1.5.0) -1. Platform version (ex: Windows Server 2012 R2) -1. Framework version (ex: Python 2.7.9) -1. Splunk version (ex: 6.3.0) -1. Other relevant information (ex: local/remote environment, Splunk network configuration) +2. Platform version (ex: Windows Server 2012 R2) +3. Framework version (ex: Python 2.7.9) +4. Splunk version (ex: 6.3.0) +5. Other relevant information (ex: local/remote environment, Splunk network configuration) -Alternatively, if you have a Splunk question please ask on [Splunk Answers][answers] +Alternatively, if you have a Splunk question please ask on [Splunk Answers](https://community.splunk.com/t5/Splunk-Development/ct-p/developer-tools). ## Pull requests @@ -22,22 +22,14 @@ We love to see pull requests! To create a pull request: -1. Fill out the [Individual Contributor Agreement][indivcontrib]. -1. Fork [the repository][repo]. -1. Make changes to the **`develop`** branch, preferably with tests. -1. Create a [pull request][pulls] against the **`develop`** branch. +1. Fill out the [Individual Contributor Agreement][https://www.splunk.com/en_us/form/contributions.html]. +1. Fork the [repository][https://github.com/splunk/splunk-sdk-python]. +1. Make changes to the **develop** branch, preferably with tests. +1. Create a [pull request][https://github.com/splunk/splunk-sdk-python/pulls] against the **develop** branch. ## Contact us -You can [contact support][contact] if you have Splunk related questions. +You can contact [Support][https://www.splunk.com/en_us/support-and-services.html] if you have questions. -You can reach the Developer Platform team at _devinfo@splunk.com_. +You can reach the Splunk Developer Platform team at _devinfo@splunk.com_. -[contributions]: http://dev.splunk.com/view/opensource/SP-CAAAEDM -[indivcontrib]: http://dev.splunk.com/goto/individualcontributions -[companycontrib]: http://dev.splunk.com/view/companycontributions/SP-CAAAEDR -[answers]: http://answers.splunk.com/ -[repo]: https://github.com/splunk/splunk-sdk-python -[issues]: https://github.com/splunk/splunk-sdk-python/issues -[pulls]: https://github.com/splunk/splunk-sdk-python/pulls -[contact]: https://www.splunk.com/en_us/support-and-services.html diff --git a/README.md b/README.md index bf5f60d09..6f065a32f 100644 --- a/README.md +++ b/README.md @@ -180,7 +180,7 @@ Stay connected with other developers building on the Splunk platform. ### Contributions -If you would like to contribute to the SDK, see [Contributions to Splunk](https://www.splunk.com/en_us/form/contributions.html). +If you would like to contribute to the SDK, see [Contributing to Splunk](https://www.splunk.com/en_us/form/contributions.html). For additional guidelines, see [CONTRIBUTING](CONTRIBUTING.md). ### Support From d14fcaa1daca25dd575109ebbba95bccb72fd276 Mon Sep 17 00:00:00 2001 From: "SPLUNKCORP\\apruneda" Date: Wed, 16 Sep 2020 17:09:27 -0700 Subject: [PATCH 15/18] edits --- CONTRIBUTING.md | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 8c8eccd87..94dd10435 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -2,7 +2,7 @@ ## How to contribute -If you would like to contribute to this project, see [Contributions to Splunk][https://www.splunk.com/en_us/form/contributions.html] for more information. +If you would like to contribute to this project, see [Contributions to Splunk](https://www.splunk.com/en_us/form/contributions.html) for more information. ## Issues and bug reports @@ -22,14 +22,14 @@ We love to see pull requests! To create a pull request: -1. Fill out the [Individual Contributor Agreement][https://www.splunk.com/en_us/form/contributions.html]. -1. Fork the [repository][https://github.com/splunk/splunk-sdk-python]. +1. Fill out the [Individual Contributor Agreement](https://www.splunk.com/en_us/form/contributions.html). +1. Fork the [repository](https://github.com/splunk/splunk-sdk-python). 1. Make changes to the **develop** branch, preferably with tests. -1. Create a [pull request][https://github.com/splunk/splunk-sdk-python/pulls] against the **develop** branch. +1. Create a [pull request](https://github.com/splunk/splunk-sdk-python/pulls) against the **develop** branch. ## Contact us -You can contact [Support][https://www.splunk.com/en_us/support-and-services.html] if you have questions. +You can contact [Support](https://www.splunk.com/en_us/support-and-services.html) if you have questions. You can reach the Splunk Developer Platform team at _devinfo@splunk.com_. From 07b5bf50f888fe058b878a5effbe1b765969638b Mon Sep 17 00:00:00 2001 From: "SPLUNKCORP\\apruneda" Date: Wed, 16 Sep 2020 17:11:36 -0700 Subject: [PATCH 16/18] edits --- CONTRIBUTING.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 94dd10435..c8e82cb07 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -29,7 +29,7 @@ To create a pull request: ## Contact us -You can contact [Support](https://www.splunk.com/en_us/support-and-services.html) if you have questions. +Contact [Support](https://www.splunk.com/en_us/support-and-services.html) if you have questions. You can reach the Splunk Developer Platform team at _devinfo@splunk.com_. From d02403f53f75430b10318e7fc6ef751e35222916 Mon Sep 17 00:00:00 2001 From: "SPLUNKCORP\\apruneda" Date: Thu, 17 Sep 2020 12:17:53 -0700 Subject: [PATCH 17/18] Updates --- CONTRIBUTING.md | 14 +++++++------- README.md | 4 ++-- 2 files changed, 9 insertions(+), 9 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index c8e82cb07..6de8fccd8 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -10,9 +10,9 @@ If you're seeing some unexpected behavior with this project, please create an [i 1. Version of this project you're using (ex: 1.5.0) 2. Platform version (ex: Windows Server 2012 R2) -3. Framework version (ex: Python 2.7.9) -4. Splunk version (ex: 6.3.0) -5. Other relevant information (ex: local/remote environment, Splunk network configuration) +3. Framework version (ex: Python 3.7) +4. Splunk Enterprise version (ex: 8.0) +5. Other relevant information (ex: local/remote environment, Splunk network configuration, standalone or distributed deployment, are load balancers used) Alternatively, if you have a Splunk question please ask on [Splunk Answers](https://community.splunk.com/t5/Splunk-Development/ct-p/developer-tools). @@ -23,13 +23,13 @@ We love to see pull requests! To create a pull request: 1. Fill out the [Individual Contributor Agreement](https://www.splunk.com/en_us/form/contributions.html). -1. Fork the [repository](https://github.com/splunk/splunk-sdk-python). -1. Make changes to the **develop** branch, preferably with tests. -1. Create a [pull request](https://github.com/splunk/splunk-sdk-python/pulls) against the **develop** branch. +2. Fork the [repository](https://github.com/splunk/splunk-sdk-python). +3. Make changes to the **develop** branch, preferably with tests. +4. Create a [pull request](https://github.com/splunk/splunk-sdk-python/pulls) against the **develop** branch. ## Contact us -Contact [Support](https://www.splunk.com/en_us/support-and-services.html) if you have questions. +If you have a paid Splunk Enterprise or Splunk Cloud license, you can contact [Support](https://www.splunk.com/en_us/support-and-services.html) with questions. You can reach the Splunk Developer Platform team at _devinfo@splunk.com_. diff --git a/README.md b/README.md index 6f065a32f..655935b5a 100644 --- a/README.md +++ b/README.md @@ -24,9 +24,9 @@ The Splunk Enterprise SDK for Python contains library code and examples that sho Here's what you need to get going with the Splunk Enterprise SDK for Python. -* Python 2.7+ and Python 3. +* Python 2.7+ or Python 3.7. - The Splunk Enterprise SDK for Python has been tested with Python v2.7 and v3.5. + The Splunk Enterprise SDK for Python has been tested with Python v2.7 and v3.7. * Splunk Enterprise From 857cc37e6b172663abca51531af847dbf29f5e6d Mon Sep 17 00:00:00 2001 From: "SPLUNKCORP\\apruneda" Date: Thu, 17 Sep 2020 14:36:58 -0700 Subject: [PATCH 18/18] Updates --- README.md | 10 +++++----- splunkrc.spec | 12 ++++++------ 2 files changed, 11 insertions(+), 11 deletions(-) diff --git a/README.md b/README.md index 655935b5a..4d2241222 100644 --- a/README.md +++ b/README.md @@ -75,17 +75,17 @@ To connect to Splunk Enterprise, many of the SDK examples and unit tests take co To use this convenience file, create a text file with the following format: - # Splunk host (default: localhost) + # Splunk Enterprise host (default: localhost) host=localhost - # Splunk admin port (default: 8089) + # Splunk Enterprise admin port (default: 8089) port=8089 - # Splunk username + # Splunk Enterprise username username=admin - # Splunk password + # Splunk Enterprise password password=changeme # Access scheme (default: https) scheme=https - # Your version of Splunk + # Your version of Splunk Enterprise version=8.0 Save the file as **.splunkrc** in the current user's home directory. diff --git a/splunkrc.spec b/splunkrc.spec index 52c953cb0..cd158fcfd 100644 --- a/splunkrc.spec +++ b/splunkrc.spec @@ -1,12 +1,12 @@ -# Splunk host (default: localhost) +# Splunk Enterprise host (default: localhost) host=localhost -# Splunk admin port (default: 8089) +# Splunk Enterprise admin port (default: 8089) port=8089 -# Splunk username +# Splunk Enterprise username username=admin -# Splunk password +# Splunk Enterprise password password=changeme # Access scheme (default: https) scheme=https -# Your version of Splunk (default: 6.3) -version=6.3 \ No newline at end of file +# Your version of Splunk Enterprise +version=8.0 \ No newline at end of file