Skip to content

Commit e5714ca

Browse files
committed
edits
1 parent c4ef7c4 commit e5714ca

File tree

1 file changed

+22
-24
lines changed

1 file changed

+22
-24
lines changed

README.md

Lines changed: 22 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -24,18 +24,18 @@ The Splunk SDK for Python contains library code and examples that show how to pr
2424

2525
Here's what you need to get going with the Splunk SDK for Python.
2626

27-
#### Python
27+
* Python
2828

29-
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.
29+
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.
3030

31-
#### Splunk
31+
* Splunk
3232

33-
If you haven't already installed Splunk, download it [here](http://www.splunk.com/download).
34-
For more information, see the Splunk Enterprise [Installation Manual](https://docs.splunk.com/Documentation/Splunk/latest/Installation).
33+
If you haven't already installed Splunk, download it [here](http://www.splunk.com/download).
34+
For more information, see the Splunk Enterprise [_Installation Manual_](https://docs.splunk.com/Documentation/Splunk/latest/Installation).
3535

36-
#### Splunk SDK for Python
36+
* Splunk SDK for Python
3737

38-
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).
38+
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).
3939

4040

4141
### 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
6767

6868
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.
6969

70-
#### Convenience file (.splunkrc)
70+
#### Create a .splunkrc convenience file
7171

7272
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.
7373

74+
>**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.
75+
7476
To use this convenience file, create a text file with the following format:
7577

7678
# Splunk host (default: localhost)
@@ -102,10 +104,7 @@ Save the file as **.splunkrc** in the current user's home directory.
102104

103105
Click **Yes**, then continue creating the file.
104106

105-
**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.
106-
107-
108-
#### Examples
107+
#### Run the examples
109108

110109
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:
111110

@@ -119,7 +118,7 @@ To get help for an example, use the `--help` argument with an example:
119118

120119
python examplename.py --help
121120

122-
#### Unit tests
121+
#### Run the unit tests
123122

124123
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:
125124

@@ -131,16 +130,15 @@ You can also run individual test files, which are located in **/splunk-sdk-pytho
131130

132131
The test suite uses Python's standard library, the built-in `unittest` library, `pytest`, and `tox`.
133132

134-
**Notes:**
135-
136-
* The test run fails unless the [SDK App Collection](https://github.com/splunk/sdk-app-collection) app is installed.
137-
* To exclude app-specific tests, use the following command:
138-
139-
make test_no_app
140-
141-
* To learn about our testing framework, see [Splunk Test Suite](https://github.com/splunk/splunk-sdk-python/tree/master/tests) on GitHub.
142-
143-
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.
133+
>**Notes:**
134+
>* The test run fails unless the [SDK App Collection](https://github.com/splunk/sdk-app-collection) app is installed.
135+
>* To exclude app-specific tests, use the following command:
136+
>
137+
> make test_no_app
138+
>
139+
>* To learn about our testing framework, see [Splunk Test Suite](https://github.com/splunk/splunk-sdk-python/tree/master/tests) on GitHub.
140+
>
141+
> 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.
144142
145143
## Repository
146144

@@ -185,7 +183,7 @@ Stay connected with other developers building on the Splunk platform.
185183
* [Splunk Blogs](https://www.splunk.com/blog)
186184
* [Twitter](https://twitter.com/splunkdev)
187185

188-
### How to contribute
186+
### Contribute
189187

190188
If you would like to contribute to the SDK, see [Contributions to Splunk](https://www.splunk.com/en_us/form/contributions.html).
191189

0 commit comments

Comments
 (0)