Skip to content

Commit ec0f29c

Browse files
committed
Edits
More edits to the readme. Reconciled the unittest libs info with dev portal.
1 parent 84c759c commit ec0f29c

File tree

1 file changed

+15
-15
lines changed

1 file changed

+15
-15
lines changed

README.md

Lines changed: 15 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -63,21 +63,20 @@ Alternatively, you can use **setup.py** on the sources you cloned from GitHub:
6363

6464
[sudo] python setup.py install
6565

66-
However, it's not necessarry to install the libraries to run the
66+
However, it's not necessary to install the libraries to run the
6767
examples and unit tests from the SDK.
6868

6969

70-
### Running the examples and units
70+
### Running the examples and unit tests
7171

7272
To run the examples and unit tests, you must put the root of
7373
the SDK on your PYTHONPATH. For example, add the following line to your **.bash_profile**:
7474

7575
export PYTHONPATH=~/splunk-sdk-python
7676

77-
The SDK command line examples require a common set of command line arguments
78-
that specify things like the Splunk host and port and login credentials. You
79-
can get a full list of command line arguments by typing `--help` as an argument
80-
to any of the command line examples.
77+
The SDK command-line examples require a common set of arguments
78+
that specify things like the Splunk host, port, and login credentials. For a full list of
79+
command-line arguments, include `--help` as an argument to any of the examples.
8180

8281
#### .splunkrc
8382

@@ -145,18 +144,19 @@ To get help for an example, use the `--help` argument with an example:
145144

146145
#### Unit tests
147146

148-
The Splunk Python SDK contains a collection of unit tests. To run them, go to the
149-
**/splunk-sdk-python/tests** directory and enter:
147+
The Splunk Python SDK contains a collection of unit tests. To run them, open a command prompt in the
148+
**/splunk-sdk-python** directory and enter:
150149

151-
python runtests.py
150+
python setup.py test
152151

153-
You can also run the test_all.py script in the tests/ directory.
152+
You can also run individual test files, which are located in **/splunk-sdk-python/tests**. For example,
153+
to run the apps test, open a command prompt in the **/splunk-sdk-python/tests** subdirectory and enter:
154154

155-
If you are using Python 2.7, the test suite will run using only Python's
156-
standard library. If you are using Python 2.6, you need to install the
157-
`unittest2` library, since the test suite depends on features added to
158-
`unittest` in Python 2.7. `unittest2` is only needed for the running test
159-
suite, not for using the SDK.
155+
python test_app.py
156+
157+
The test suite uses Python's standard library and the built-in `unittest` library. If you're using Python 2.7,
158+
you're all set. However, if you are using Python 2.6, you'll also need to install the `unittest2` library to
159+
get the additional features that were added to Python 2.7.
160160

161161
You can read more about our testing framework on
162162
[GitHub](https://github.com/splunk/splunk-sdk-python/tree/master/tests).

0 commit comments

Comments
 (0)