Update searchcommands app example (#240)

searchcommands_app example now packages splunklib under lib folder instead of bin folder based on best practice

Author: Eric Cheng

.gitignore

@@ -6,6 +6,7 @@
 .coverage
 .coverage.*
 .python-version
+.vscode
 __stdout__
 docs/_build
 build/
@@ -24,7 +25,7 @@ tests/searchcommands/data/app/app.log
 splunk_sdk.egg-info/
 dist/
 examples/searchcommands_app/package/default/commands.conf
-examples/searchcommands_app/package/bin/packages
+examples/searchcommands_app/package/lib/splunklib
 tests/searchcommands/apps/app_with_logging_configuration/*.log
 *.observed
 venv/

examples/searchcommands_app/README.md

@@ -15,14 +15,14 @@ The app is tested on Splunk 5 and 6. Here is its manifest:
 
 ```
 ├── bin
-│   ├── splunklib
-│   │   └── searchcommands ....... splunklib.searchcommands module
 │   ├── countmatches.py .......... CountMatchesCommand implementation
 │   ├── generatetext.py .......... GenerateTextCommand implementation
 │   ├── pypygeneratetext.py ...... Executes generatetext.py with PyPy
 │   ├── simulate.py .............. SimulateCommand implementation
-│   ├── sum.py ................... SumCommand implementation
-│   └── 
+│   └── sum.py ................... SumCommand implementation
+├── lib
+|   └── splunklib
+│      └── searchcommands ....... splunklib.searchcommands module
 ├── default
 │   ├── data
 │   │   └── ui

examples/searchcommands_app/package/bin/countmatches.py

@@ -17,9 +17,11 @@
 
 from __future__ import absolute_import, division, print_function, unicode_literals
 import app
+import os,sys
 
+splunkhome = os.environ['SPLUNK_HOME']
+sys.path.append(os.path.join(splunkhome, 'etc', 'apps', 'searchcommands_app', 'lib'))
 from splunklib.searchcommands import dispatch, StreamingCommand, Configuration, Option, validators
-import sys
 from splunklib import six
 
 

examples/searchcommands_app/package/bin/filter.py

@@ -17,13 +17,13 @@
 
 from __future__ import absolute_import, division, print_function, unicode_literals
 import app
+import os,sys
 
+splunkhome = os.environ['SPLUNK_HOME']
+sys.path.append(os.path.join(splunkhome, 'etc', 'apps', 'searchcommands_app', 'lib'))
 from splunklib.searchcommands import dispatch, EventingCommand, Configuration, Option
 from splunklib.searchcommands.validators import Code
 
-import sys
-
-
 @Configuration()
 class FilterCommand(EventingCommand):
     """ Filters, augments, and updates records on the events stream.

examples/searchcommands_app/package/bin/generatehello.py

@@ -17,11 +17,13 @@
 
 from __future__ import absolute_import, division, print_function, unicode_literals
 import app
+import os,sys
+import time
 
+splunkhome = os.environ['SPLUNK_HOME']
+sys.path.append(os.path.join(splunkhome, 'etc', 'apps', 'searchcommands_app', 'lib'))
 from splunklib.searchcommands import dispatch, GeneratingCommand, Configuration, Option, validators
-import sys
-import time
-from six.moves import range
+from splunklib.six.moves import range
 
 
 @Configuration()

examples/searchcommands_app/package/bin/generatetext.py

@@ -17,10 +17,12 @@
 
 from __future__ import absolute_import, division, print_function, unicode_literals
 import app
+import os,sys
+import time
 
+splunkhome = os.environ['SPLUNK_HOME']
+sys.path.append(os.path.join(splunkhome, 'etc', 'apps', 'searchcommands_app', 'lib'))
 from splunklib.searchcommands import dispatch, GeneratingCommand, Configuration, Option, validators
-import sys
-import time
 from splunklib import six
 from splunklib.six.moves import range
 

examples/searchcommands_app/package/bin/pypygeneratetext.py

@@ -63,11 +63,12 @@
 
 from __future__ import absolute_import, division, print_function, unicode_literals
 import app
-
-from splunklib.searchcommands import app_root, execute
+import sys
 from os import environ, path
 
-import sys
+splunkhome = environ['SPLUNK_HOME']
+sys.path.append(path.join(splunkhome, 'etc', 'apps', 'searchcommands_app', 'lib'))
+from splunklib.searchcommands import app_root, execute
 
 pypy_argv = ['pypy', path.join(app_root, 'bin', 'generatetext.py')] + sys.argv[1:]
 pypy_environ = dict(environ)

examples/searchcommands_app/package/bin/simulate.py

@@ -17,13 +17,15 @@
 
 from __future__ import absolute_import, division, print_function, unicode_literals
 import app
-
-from splunklib.searchcommands import dispatch, GeneratingCommand, Configuration, Option, validators
 import random
 import csv
-import sys
+import os,sys
 import time
 
+splunkhome = os.environ['SPLUNK_HOME']
+sys.path.append(os.path.join(splunkhome, 'etc', 'apps', 'searchcommands_app', 'lib'))
+from splunklib.searchcommands import dispatch, GeneratingCommand, Configuration, Option, validators
+
 
 @Configuration()
 class SimulateCommand(GeneratingCommand):

examples/searchcommands_app/package/bin/sum.py

@@ -17,9 +17,11 @@
 
 from __future__ import absolute_import, division, print_function, unicode_literals
 import app
+import os,sys
 
+splunkhome = os.environ['SPLUNK_HOME']
+sys.path.append(os.path.join(splunkhome, 'etc', 'apps', 'searchcommands_app', 'lib'))
 from splunklib.searchcommands import dispatch, ReportingCommand, Configuration, Option, validators
-import sys
 
 
 @Configuration(requires_preop=True)

examples/searchcommands_app/setup.py

@@ -88,7 +88,7 @@ def install_packages(app_root, distribution):
     if not requires:
         return
 
-    target = os.path.join(app_root, 'bin', 'packages')
+    target = os.path.join(app_root, 'lib', 'packages')
 
     if not os.path.isdir(target):
         os.mkdir(target)
@@ -323,7 +323,7 @@ def run(self):
             message = 'Cannot create a link at "{}" because a file by that name already exists.'.format(target)
             raise SystemError(message)
 
-        packages = os.path.join(self.app_source, 'bin', 'packages')
+        packages = os.path.join(self.app_source, 'lib')
 
         if not os.path.isdir(packages):
             os.mkdir(packages)
@@ -454,13 +454,12 @@ def run(self):
             'Topic :: System :: Logging',
             'Topic :: System :: Monitoring'],
         packages=[
-            'bin.packages.splunklib', 'bin.packages.splunklib.searchcommands'
+            'lib.splunklib', 'lib.splunklib.searchcommands'
         ],
         package_dir={
-            'bin': os.path.join('package', 'bin'),
-            'bin.packages': os.path.join('package', 'bin', 'packages'),
-            'bin.packages.splunklib': os.path.join('..', '..', 'splunklib'),
-            'bin.packages.splunklib.searchcommands': os.path.join('..', '..', 'splunklib', 'searchcommands')
+            'lib': os.path.join('package', 'lib'),
+            'lib.splunklib': os.path.join('..', '..', 'splunklib'),
+            'lib.splunklib.searchcommands': os.path.join('..', '..', 'splunklib', 'searchcommands')
         },
         package_data={
             'bin': [