Skip to content

Commit df10be9

Browse files
committed
Update samples to use splunklib instead of splunk + a couple of formatting changes.
1 parent 5b598ac commit df10be9

File tree

1 file changed

+60
-22
lines changed

1 file changed

+60
-22
lines changed

README.md

Lines changed: 60 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -126,7 +126,7 @@ including:
126126

127127
You can see an example use of the library here:
128128

129-
import splunk.binding as binding
129+
import splunklib.binding as binding
130130

131131
# host defaults to localhost and port defaults to 8089
132132
context = binding.connect(username="admin", password="changeme")
@@ -140,7 +140,7 @@ The second layer is referred to as the _client_ layer and builds on the
140140
_binding_ layer to provide a friendlier interface to Splunk that abstracts
141141
away some of the lower level details of the _binding_ layer.
142142

143-
import splunk.client as client
143+
import splunklib.client as client
144144

145145
# host defaults to localhost and port defaults to 8089
146146
service = client.connect(username="admin", password="changeme")
@@ -161,20 +161,34 @@ Alternatively, you can read more about our testing "framework"
161161

162162
### Layout of the repository
163163

164-
<dl>
165-
<dt>./docs</dt>
166-
<dd>Contains a few detailed notes specific to the SDK. In general documentation
167-
about developing on Splunk can be found on dev.splunk.com.</dd>
168-
<dt>./examples</dt>
169-
<dd>Contains s variety of Splunk samples demonstrating the various library
170-
modules.</dd>
171-
<dt>./splunk</dt>
172-
<dd>The Splunk library modules.</dd>
173-
<dt>./tests</dt>
174-
<dd>The SDK unit tests.</dd>
175-
<dt>./utils</dt>
176-
<dd>Generic utility code shared by the examples and unit tests.</dd>
177-
</dl>
164+
<table>
165+
166+
<tr>
167+
<td>docs</td>
168+
<td>Source for Sphinx based docs and build</td>
169+
</tr>
170+
171+
<tr>
172+
<td>examples</td>
173+
<td>Examples demonstrating various SDK features</td>
174+
<tr>
175+
176+
<tr>
177+
<td>splunklib</td>
178+
<td>Source for the Splunk library modules</td>
179+
<tr>
180+
181+
<tr>
182+
<td>tests</td>
183+
<td>Source for unit tests</td>
184+
<tr>
185+
186+
<tr>
187+
<td>utils</td>
188+
<td>Source for utilities shared by the examples and unit tests</td>
189+
<tr>
190+
191+
</table>
178192

179193
### Changelog
180194

@@ -204,12 +218,36 @@ For a gentle introduction to the Splunk product and some of its capabilities:
204218

205219
## Community
206220

207-
* Email: Stay connected with other developers building on Splunk: [email protected]
208-
* Issues: https://github.com/splunk/splunk-sdk-python/issues
209-
* Answers: Check out this tag on Splunk answers for:
210-
http://splunk-base.splunk.com/tags/python/
211-
* Blog: http://blogs.splunk.com/dev/
212-
* Twitter: [@splunkdev](http://twitter.com)
221+
tay connected with other developers building on Splunk.
222+
223+
<table>
224+
225+
<tr>
226+
<td><em>Email</em></td>
227+
228+
</tr>
229+
230+
<tr>
231+
<td><em>Issues</em>
232+
<td><span>https://github.com/splunk/splunk-sdk-java/issues/</span></td>
233+
</tr>
234+
235+
<tr>
236+
<td><em>Answers</em>
237+
<td><span>http://splunk-base.splunk.com/tags/java/</span></td>
238+
</tr>
239+
240+
<tr>
241+
<td><em>Blog</em>
242+
<td><span>http://blogs.splunk.com/dev/</span></td>
243+
</tr>
244+
245+
<tr>
246+
<td><em>Twitter</em>
247+
<td>@splunkdev</td>
248+
</tr>
249+
250+
</table>
213251

214252
### How to contribute
215253

0 commit comments

Comments
 (0)