Skip to content

Commit ce1fa15

Browse files
author
Frederick Ross
committed
Merge branch 'develop' of github.com:splunk/splunk-sdk-python into develop
2 parents caebb63 + 27cd48f commit ce1fa15

File tree

6 files changed

+23
-23
lines changed

6 files changed

+23
-23
lines changed

CHANGELOG.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# Splunk Python SDK Changelog
1+
# Splunk SDK for Python Changelog
22

33
## Version 1.0
44

README.md

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -19,9 +19,9 @@ technology used by the Splunk product to build exciting new applications that
1919
are enabled by Splunk's unique capabilities.
2020

2121

22-
## Getting started with the Splunk Python SDK
22+
## Getting started with the Splunk SDK for Python
2323

24-
The Splunk Python SDK contains library code and examples that show how to
24+
The Splunk SDK for Python contains library code and examples that show how to
2525
programmatically interact with Splunk for a variety of scenarios including
2626
searching, saved searches, data inputs, and many more, along with building
2727
complete applications.
@@ -31,11 +31,11 @@ in-depth information be sure to visit the
3131
[Splunk Developer Portal](http://dev.splunk.com/view/SP-CAAAEBB).
3232
### Requirements
3333

34-
Here's what you need to get going with the Splunk Python SDK.
34+
Here's what you need to get going with the Splunk SDK for Python.
3535

3636
#### Python
3737

38-
The Splunk Python SDK requires Python 2.6+.
38+
The Splunk SDK for Python requires Python 2.6+.
3939

4040
#### Splunk
4141

@@ -44,15 +44,15 @@ If you haven't already installed Splunk, download it
4444
Splunk and system requirements, see
4545
[Installing & Running Splunk](http://dev.splunk.com/view/SP-CAAADRV).
4646

47-
#### Splunk Python SDK
48-
Get the Splunk Python SDK from [GitHub](https://github.com/) and clone the
47+
#### Splunk SDK for Python
48+
Get the Splunk SDK for Python from [GitHub](https://github.com/) and clone the
4949
resources to your computer. For example, use the following command:
5050

5151
git clone https://github.com/splunk/splunk-sdk-python.git
5252

5353
### Installing the SDK
5454

55-
You can install the Splunk Python SDK libraries by using `easy_install` or `pip`:
55+
You can install the Splunk SDK for Python libraries by using `easy_install` or `pip`:
5656

5757
[sudo] easy_install splunk-sdk
5858

@@ -151,7 +151,7 @@ To get help for an example, use the `--help` argument with an example:
151151

152152
#### Unit tests
153153

154-
The Splunk Python SDK contains a collection of unit tests. To run them, open a
154+
The Splunk SDK for Python contains a collection of unit tests. To run them, open a
155155
command prompt in the **/splunk-sdk-python** directory and enter:
156156

157157
python setup.py test
@@ -220,10 +220,10 @@ If you need to know more:
220220
[Splunk Developer Portal](http://dev.splunk.com).
221221

222222
* For conceptual and how-to documentation, see the
223-
[Overview of the Splunk Python SDK](http://dev.splunk.com/view/SP-CAAAEBB).
223+
[Overview of the Splunk SDK for Python](http://dev.splunk.com/view/SP-CAAAEBB).
224224

225225
* For API reference documentation, see the
226-
[Splunk Python SDK Reference](http://docs.splunk.com/Documentation/PythonSDK).
226+
[Splunk SDK for Python Reference](http://docs.splunk.com/Documentation/PythonSDK).
227227

228228
* For more about the Splunk REST API, see the
229229
[REST API Reference](http://docs.splunk.com/Documentation/Splunk/latest/RESTAPI).
@@ -281,7 +281,7 @@ If you would like to contribute to the SDK, go here for more information:
281281

282282
1. You will be granted support if you or your company are already covered
283283
under an existing maintenance/support agreement. Send an email to
284-
_[email protected]_ and include "Splunk Python SDK" in the subject line.
284+
_[email protected]_ and include "Splunk SDK for Python" in the subject line.
285285

286286
2. If you are not covered under an existing maintenance/support agreement, you
287287
can find help through the broader community at:

docs/conf.py

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# -*- coding: utf-8 -*-
22
#
3-
# Splunk Python SDK documentation build configuration file, created by
3+
# Splunk SDK for Python documentation build configuration file, created by
44
# sphinx-quickstart on Fri Apr 13 12:28:15 2012.
55
#
66
# This file is execfile()d with the current directory set to its containing dir.
@@ -42,7 +42,7 @@
4242
master_doc = 'index'
4343

4444
# General information about the project.
45-
project = u'Splunk Python SDK'
45+
project = u'Splunk SDK for Python'
4646
copyright = u'2012, Splunk Inc'
4747

4848
# The version info for the project you're documenting, acts as replacement for
@@ -107,10 +107,10 @@
107107

108108
# The name for this set of Sphinx documents. If None, it defaults to
109109
# "<project> v<release> documentation".
110-
html_title = "Splunk Python SDK Reference"
110+
html_title = "Splunk SDK for Python Reference"
111111

112112
# A shorter title for the navigation bar. Default is the same as html_title.
113-
#html_short_title = "Splunk Python SDK Reference"
113+
#html_short_title = "Splunk SDK for Python Reference"
114114

115115
# The name of an image file (relative to this directory) to place at the top
116116
# of the sidebar.
@@ -191,7 +191,7 @@
191191
# Grouping the document tree into LaTeX files. List of tuples
192192
# (source start file, target name, title, author, documentclass [howto/manual]).
193193
latex_documents = [
194-
('index', 'SplunkPythonSDK.tex', u'Splunk Python SDK Documentation',
194+
('index', 'SplunkPythonSDK.tex', u'Splunk SDK for Python Documentation',
195195
u'Splunk Inc.', 'manual'),
196196
]
197197

@@ -221,7 +221,7 @@
221221
# One entry per manual page. List of tuples
222222
# (source start file, name, description, authors, manual section).
223223
man_pages = [
224-
('index', 'splunkpythonsdk', u'Splunk Python SDK Documentation',
224+
('index', 'splunkpythonsdk', u'Splunk SDK for Python Documentation',
225225
[u'Splunk Inc.'], 1)
226226
]
227227

@@ -235,7 +235,7 @@
235235
# (source start file, target name, title, author,
236236
# dir menu entry, description, category)
237237
texinfo_documents = [
238-
('index', 'SplunkPythonSDK', u'Splunk Python SDK Documentation',
238+
('index', 'SplunkPythonSDK', u'Splunk SDK for Python Documentation',
239239
u'Splunk Inc.', 'SplunkPythonSDK', 'One line description of project.',
240240
'Miscellaneous'),
241241
]

docs/index.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
1-
Welcome to the API reference for the Splunk Python SDK, which describes the modules that are included in the Splunk Python SDK.
2-
For more information about the SDK, see the `Splunk Developer Portal <http://dev.splunk.com/view/python-sdk/SP-CAAAEBB>`_.
1+
Welcome to the API reference for the Splunk SDK for Python, which describes the modules that are included in the SDK.
2+
For more information, see the `Splunk Developer Portal <http://dev.splunk.com/view/python-sdk/SP-CAAAEBB>`_.
33

44
.. toctree::
55
:maxdepth: 2

examples/async/async.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@
1515
# under the License.
1616

1717
# A sample that demonstrates a custom HTTP handler for the Splunk service,
18-
# as well as showing how you could use the Splunk Python SDK with coroutine
18+
# as well as showing how you could use the Splunk SDK for Python with coroutine
1919
# based systems like Eventlet.
2020

2121
#### Main Code

tests/test_all.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@
1414
# License for the specific language governing permissions and limitations
1515
# under the License.
1616

17-
"""Runs all the Splunk Python SDK unit tests."""
17+
"""Runs all the Splunk SDK for Python unit tests."""
1818

1919
import os
2020
try:

0 commit comments

Comments
 (0)