The Splunk Software Development Kit (SDK) for Python contains library code and

map-reduce architecture to efficiently index, search and process large

programmatically interact with Splunk for a variety of scenarios including

searching, saved searches, data inputs, and many more, along with building

complete applications.

in-depth information be sure to visit the

[Splunk Developer Portal](http://dev.splunk.com/view/SP-CAAAEBB).

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.

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

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

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.

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

* For example on OS X, save the file as:

* On Windows, save the file as:

the command line to create this file—go to the

**C:\Users\currentusername** directory and enter the following command:

**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.

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

If you saved your login credentials in the **.splunkrc** file, you can omit

The Splunk SDK for Python contains a collection of unit tests. To run them, open a

python setup.py test

You can also run individual test files, which are located in

**/splunk-sdk-python/tests**. For example, to run the apps test, open a command

prompt in the **/splunk-sdk-python/tests** subdirectory and enter:

python test_app.py

The test suite uses Python's standard library and the built-in `unittest`

library.

of changes for each version of the SDK. You can also find it online at

You can read more about our branching model on our Wiki at

If you need to know more:

* For all things developer with Splunk, your main resource is the

* For conceptual and how-to documentation, see the

* For API reference documentation, see the

* For more about the Splunk REST API, see the

* For more about about Splunk in general, see

* For more about this SDK's repository, see our

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:

<ul>

<li><a href='http://splunk-base.splunk.com/answers/'>Splunk Answers</a> (use

the <b>sdk</b>, <b>java</b>, <b>python</b>, and <b>javascript</b> tags to

identify your questions)</li>

</ul>

3. Splunk will NOT provide support for SDKs if the core library (the

code in the <b>/splunklib</b> 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&mdash;please send feedback to devinfo@splunk.com.