Skip to content

Commit 70931cd

Browse files
author
David Noble
committed
Release 1.2
2 parents 6f6d8b0 + 29930fb commit 70931cd

File tree

141 files changed

+7802
-332
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

141 files changed

+7802
-332
lines changed

‎.gitattributes

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
1+
tests/searchcommands_data/_expected_results/* binary
2+
tests/searchcommands_data/input/* binary

‎.gitignore

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,4 +14,6 @@ MANIFEST
1414
coverage_report
1515
test.log
1616
examples/*/local
17-
examples/*/metadata
17+
examples/*/metadata
18+
tests/searchcommands_data/log/
19+
tests/searchcommands_data/output/

‎CHANGELOG.md

Lines changed: 28 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,33 @@
11
# Splunk SDK for Python Changelog
22

3+
## Version 1.2
4+
5+
### New features and APIs
6+
7+
* Added support for building custom search commands in Python using the Splunk
8+
SDK for Python.
9+
10+
### Bug fix
11+
12+
* When running `setup.py dist` without running `setup.py build`, there is no
13+
longer an `No such file or directory` error on the command line, and the
14+
command behaves as expected.
15+
16+
* When setting the sourcetype of a modular input event, events are indexed properly.
17+
Previously Splunk would encounter an error and skip them.
18+
19+
### Breaking changes
20+
21+
* If modular inputs were not being indexed by Splunk because a sourcetype was set
22+
(and the SDK was not handling them correctly), they will be indexed upon updating
23+
to this version of the SDK.
24+
25+
### Minor changes
26+
27+
* Docstring corrections in the modular input examples.
28+
29+
* A minor docstring correction in `splunklib/modularinput/event_writer.py`.
30+
331
## Version 1.1
432

533
### New features and APIs

‎README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# The Splunk Software Development Kit for Python
22

3-
#### Version 1.1
3+
#### Version 1.2
44

55
The Splunk Software Development Kit (SDK) for Python contains library code and
66
examples designed to enable developers to build applications using Splunk.

‎docs/index.rst

Lines changed: 28 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,7 @@ For more information, see the `Splunk Developer Portal <http://dev.splunk.com/vi
2424

2525
**Custom HTTP handler**
2626

27-
:class:`~splunklib.binding.HTTPError` class
27+
:class:`~splunklib.binding.HTTPError` class
2828

2929
:class:`~splunklib.binding.HttpLib` class
3030

@@ -34,9 +34,9 @@ For more information, see the `Splunk Developer Portal <http://dev.splunk.com/vi
3434

3535
:func:`~splunklib.client.connect` function
3636

37-
:class:`~splunklib.client.Service` class
37+
:class:`~splunklib.client.Service` class
3838

39-
:class:`~splunklib.client.Endpoint` base class
39+
:class:`~splunklib.client.Endpoint` base class
4040

4141

4242
**Entities and collections**
@@ -88,7 +88,7 @@ For more information, see the `Splunk Developer Portal <http://dev.splunk.com/vi
8888
:class:`~splunklib.client.User` class
8989

9090
:class:`~splunklib.client.Users` class
91-
91+
9292

9393
**Exceptions**
9494

@@ -114,28 +114,39 @@ For more information, see the `Splunk Developer Portal <http://dev.splunk.com/vi
114114

115115
:func:`~splunklib.data.record` function
116116

117-
:class:`~splunklib.data.Record` class
117+
:class:`~splunklib.data.Record` class
118118

119119
:doc:`results`
120120
--------------
121121

122-
:class:`~splunklib.results.ResultsReader` class
122+
:class:`~splunklib.results.ResultsReader` class
123123

124-
:class:`~splunklib.results.Message` class
124+
:class:`~splunklib.results.Message` class
125125

126126
:doc:`modularinput`
127-
--------------
127+
-------------------
128+
129+
:class:`~splunklib.modularinput.Argument` class
130+
131+
:class:`~splunklib.modularinput.Event` class
132+
133+
:class:`~splunklib.modularinput.EventWriter` class
134+
135+
:class:`~splunklib.modularinput.InputDefinition` class
136+
137+
:class:`~splunklib.modularinput.Scheme` class
138+
139+
:class:`~splunklib.modularinput.Script` class
140+
141+
:class:`~splunklib.modularinput.ValidationDefinition` class
128142

129-
:class:`~splunklib.modularinput.Argument` class
143+
:doc:`searchcommands`
144+
---------------------
130145

131-
:class:`~splunklib.modularinput.Event` class
146+
:class:`~splunklib.searchcommands.GeneratingCommand` class
132147

133-
:class:`~splunklib.modularinput.EventWriter` class
148+
:class:`~splunklib.searchcommands.ReportingCommand` class
134149

135-
:class:`~splunklib.modularinput.InputDefinition` class
150+
:class:`~splunklib.searchcommands.StreamingCommand` class
136151

137-
:class:`~splunklib.modularinput.Scheme` class
138-
139-
:class:`~splunklib.modularinput.Script` class
140-
141-
:class:`~splunklib.modularinput.ValidationDefinition` class
152+
:class:`~splunklib.searchcommands.Option` class

‎docs/modularinput.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
splunklib.modularinput
2-
--------------
2+
----------------------
33

44
.. automodule:: splunklib.modularinput
55

‎docs/searchcommands.rst

Lines changed: 68 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,68 @@
1+
splunklib.searchcommands
2+
------------------------
3+
4+
.. automodule:: splunklib.searchcommands
5+
6+
.. autofunction:: dispatch
7+
8+
.. automodule:: splunklib.searchcommands.generating_command
9+
10+
.. autoclass:: GeneratingCommand
11+
:members:
12+
:inherited-members:
13+
14+
.. automodule:: splunklib.searchcommands.reporting_command
15+
16+
.. autoclass:: ReportingCommand
17+
:members:
18+
:inherited-members:
19+
20+
.. automodule:: splunklib.searchcommands.streaming_command
21+
22+
.. autoclass:: StreamingCommand
23+
:members:
24+
:inherited-members:
25+
26+
.. automodule:: splunklib.searchcommands.decorators
27+
28+
.. autoclass:: Configuration
29+
:members:
30+
:inherited-members:
31+
32+
.. autoclass:: Option
33+
:members:
34+
:inherited-members:
35+
36+
.. automodule:: splunklib.searchcommands.validators
37+
38+
.. autoclass:: splunklib.searchcommands.validators.Boolean
39+
:members:
40+
:inherited-members:
41+
42+
.. autoclass:: splunklib.searchcommands.validators.Duration
43+
:members:
44+
:inherited-members:
45+
46+
.. autoclass:: splunklib.searchcommands.validators.Fieldname
47+
:members:
48+
:inherited-members:
49+
50+
.. autoclass:: splunklib.searchcommands.validators.File
51+
:members:
52+
:inherited-members:
53+
54+
.. autoclass:: splunklib.searchcommands.validators.Integer
55+
:members:
56+
:inherited-members:
57+
58+
.. autoclass:: splunklib.searchcommands.validators.RegularExpression
59+
:members:
60+
:inherited-members:
61+
62+
.. autoclass:: splunklib.searchcommands.validators.Set
63+
:members:
64+
:inherited-members:
65+
66+
.. autoclass:: splunklib.searchcommands.validators.Validator
67+
:members:
68+
:inherited-members:

‎examples/abc/a.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# Copyright 2011-2012 Splunk, Inc.
1+
# Copyright 2011-2013 Splunk, Inc.
22
#
33
# Licensed under the Apache License, Version 2.0 (the "License"): you may
44
# not use this file except in compliance with the License. You may obtain

‎examples/abc/b.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# Copyright 2011-2012 Splunk, Inc.
1+
# Copyright 2011-2013 Splunk, Inc.
22
#
33
# Licensed under the Apache License, Version 2.0 (the "License"): you may
44
# not use this file except in compliance with the License. You may obtain

‎examples/abc/c.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# Copyright 2011-2012 Splunk, Inc.
1+
# Copyright 2011-2013 Splunk, Inc.
22
#
33
# Licensed under the Apache License, Version 2.0 (the "License"): you may
44
# not use this file except in compliance with the License. You may obtain

0 commit comments

Comments
 (0)