The Splunk Software Development Kit for Python
The Splunk Software Development Kit (SDK) for Python contains library code and examples designed to enable developers to build applications using Splunk.
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 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.
Getting 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 information in this Readme provides steps to get going quickly, but for more in-depth information be sure to visit the Splunk Developer Portal.
Here's what you need to get going with the Splunk SDK for Python.
The Splunk SDK for Python requires Python 2.7+, including Python 3.
Splunk SDK for Python
Installing the SDK
You can install the Splunk SDK for Python libraries by using
[sudo] easy_install splunk-sdk
[sudo] pip install splunk-sdk
Or to install the Python egg
[sudo] pip install --egg splunk-sdk
Alternatively, you can use setup.py on 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
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:
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
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 use this convenience file, create a text file with the following format:
# Splunk host (default: localhost) host=localhost # Splunk admin port (default: 8089) port=8089 # Splunk username username=admin # Splunk password password=changeme # Access scheme (default: https) scheme=https # Your version of Splunk (default: 5.0) version=5.0
Save the file as .splunkrc in the current user's home directory.
For example on OS X, save the file as:
On Windows, save the file as:
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:
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.
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:
To get help for an example, use the
--help argument with an example:
python examplename.py --help
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:
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:
The test suite uses Python's standard library and the built-in
You can read more about our testing framework on GitHub.
|/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|
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.
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.
Documentation and resources
If you need to know more:
For all things developer with Splunk, your main resource is the Splunk Developer Portal.
For conceptual and how-to documentation, see the Overview of the Splunk SDK for Python.
For API reference documentation, see the Splunk SDK for Python Reference.
For more about the Splunk REST API, see the REST API Reference.
For more about about Splunk in general, see Splunk>Docs.
For more about this SDK's repository, see our GitHub Wiki.
Stay connected with other developers building on Splunk.
How to contribute
If you would like to contribute to the SDK, go here for more information:
- You will be granted support if you or your company are already covered under an existing maintenance/support agreement. Send an email to firstname.lastname@example.org 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 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 email@example.com.
- File any issues on GitHub.
You can reach the Developer Platform team at firstname.lastname@example.org.
The Splunk Software Development Kit for Python is licensed under the Apache License 2.0. Details can be found in the file LICENSE.