Working through release steps

* Confirmed that with this change this command produces the desired results: ./setup.py build dist sdist bdist_egg

Author: David Noble

examples/searchcommands_app/setup.py

@@ -57,7 +57,6 @@ def symlink(source, link_name):
     patch_os()
     del locals()['patch_os']  # since this function has done its job
 
-
 from collections import OrderedDict
 from glob import glob
 from itertools import chain
@@ -423,54 +422,60 @@ def run(self):
 
 # endregion
 
-setup(
-    description='Custom Search Command examples',
-    name=os.path.basename(project_dir),
-    version='1.5.0',
-    author='Splunk, Inc.',
-    author_email='[email protected]',
-    url='http://github.com/splunk/splunk-sdk-python',
-    license='http://www.apache.org/licenses/LICENSE-2.0',
-    classifiers=[
-        'Development Status :: 5 - Production/Stable',
-        'Environment :: Other Environment',
-        'Intended Audience :: Information Technology',
-        'License :: Other/Proprietary License',
-        'Operating System :: OS Independent',
-        'Programming Language :: Python',
-        'Topic :: System :: Logging',
-        'Topic :: System :: Monitoring'],
-    packages=[
-        b'bin.packages.splunklib', b'bin.packages.splunklib.searchcommands'
-    ],
-    package_dir={
-        b'bin': os.path.join('package', 'bin'),
-        b'bin.packages': os.path.join('package', 'bin', 'packages'),
-        b'bin.packages.splunklib': os.path.join('..', '..', 'splunklib'),
-        b'bin.packages.splunklib.searchcommands': os.path.join('..', '..', 'splunklib', 'searchcommands')
-    },
-    package_data={
-        b'bin': [
-            os.path.join('package', 'bin', 'app.py'),
-            os.path.join('package', 'bin', 'countmatches.py'),
-            os.path.join('package', 'bin', 'filter.py'),
-            os.path.join('package', 'bin', 'generatehello.py'),
-            os.path.join('package', 'bin', 'generatetext.py'),
-            os.path.join('package', 'bin', 'pypygeneratetext.py'),
-            os.path.join('package', 'bin', 'simulate.py'),
-            os.path.join('package', 'bin', 'sum.py')
-        ]
-    },
-    data_files=[
-        (b'README', [os.path.join('package', 'README', '*.conf.spec')]),
-        (b'default', [os.path.join('package', 'default', '*.conf')]),
-        (b'lookups', [os.path.join('package', 'lookups', '*.csv.gz')]),
-        (b'metadata', [os.path.join('package', 'metadata', 'default.meta')])
-    ],
-    requires=[],
-
-    cmdclass=OrderedDict((
-        ('analyze', AnalyzeCommand), 
-        ('build', BuildCommand),
-        ('link', LinkCommand),
-        ('test', TestCommand))))
+current_directory = os.getcwdu()
+os.chdir(project_dir)
+
+try:
+    setup(
+        description='Custom Search Command examples',
+        name=os.path.basename(project_dir),
+        version='1.5.0',
+        author='Splunk, Inc.',
+        author_email='[email protected]',
+        url='http://github.com/splunk/splunk-sdk-python',
+        license='http://www.apache.org/licenses/LICENSE-2.0',
+        classifiers=[
+            'Development Status :: 5 - Production/Stable',
+            'Environment :: Other Environment',
+            'Intended Audience :: Information Technology',
+            'License :: Other/Proprietary License',
+            'Operating System :: OS Independent',
+            'Programming Language :: Python',
+            'Topic :: System :: Logging',
+            'Topic :: System :: Monitoring'],
+        packages=[
+            b'bin.packages.splunklib', b'bin.packages.splunklib.searchcommands'
+        ],
+        package_dir={
+            b'bin': os.path.join('package', 'bin'),
+            b'bin.packages': os.path.join('package', 'bin', 'packages'),
+            b'bin.packages.splunklib': os.path.join('..', '..', 'splunklib'),
+            b'bin.packages.splunklib.searchcommands': os.path.join('..', '..', 'splunklib', 'searchcommands')
+        },
+        package_data={
+            b'bin': [
+                os.path.join('package', 'bin', 'app.py'),
+                os.path.join('package', 'bin', 'countmatches.py'),
+                os.path.join('package', 'bin', 'filter.py'),
+                os.path.join('package', 'bin', 'generatehello.py'),
+                os.path.join('package', 'bin', 'generatetext.py'),
+                os.path.join('package', 'bin', 'pypygeneratetext.py'),
+                os.path.join('package', 'bin', 'simulate.py'),
+                os.path.join('package', 'bin', 'sum.py')
+            ]
+        },
+        data_files=[
+            (b'README', [os.path.join('package', 'README', '*.conf.spec')]),
+            (b'default', [os.path.join('package', 'default', '*.conf')]),
+            (b'lookups', [os.path.join('package', 'lookups', '*.csv.gz')]),
+            (b'metadata', [os.path.join('package', 'metadata', 'default.meta')])
+        ],
+        requires=[],
+
+        cmdclass=OrderedDict((
+            ('analyze', AnalyzeCommand),
+            ('build', BuildCommand),
+            ('link', LinkCommand),
+            ('test', TestCommand))))
+finally:
+    os.chdir(current_directory)

setup.py

@@ -16,12 +16,15 @@
 
 from setuptools import setup, Command
 from contextlib import closing
-from fnmatch import fnmatch
+from subprocess import check_call, STDOUT
 
 import os
-import splunklib
+import sys
+import shutil
 import tarfile
 
+import splunklib
+
 
 def run_test_suite():
     try:
@@ -102,7 +105,7 @@ def run(self):
 class DistCommand(Command):
     """setup.py command to create .spl files for modular input and search
     command examples"""
-    description = "Build modular input and search command example .spl files."
+    description = "Build modular input and search command example tarballs."
     user_options = []
 
     def initialize_options(self):
@@ -163,35 +166,16 @@ def run(self):
 
                 spl.close()
 
-        # Create searchcommands_app.spl
-
-        sdk_dir = os.path.abspath('.')
-
-        def exclude(path):
-            # TODO: DVPL-5866 - Replace with filter function because exclude is deprecated
-            basename = os.path.basename(path)
-            for pattern in ['.DS_Store', '.idea', '*.log', '*.py[co]']:
-                if fnmatch(basename, pattern):
-                    return True
-            return False
-
-        tarball = os.path.join(sdk_dir, 'build', 'searchcommands_app.spl')
-
-        splunklib_arcname = os.path.join(
-            'searchcommands_app', 'bin', 'splunklib')
+        # Create searchcommands_app-<three-part-version-number>-private.tar.gz
 
-        manifest = [
-            (os.path.join(sdk_dir, 'examples', 'searchcommands_app'),
-             'searchcommands_app'),
-            (os.path.join(sdk_dir, 'splunklib'),
-             splunklib_arcname)
-        ]
+        setup_py = os.path.join('examples', 'searchcommands_app', 'setup.py')
 
-        with closing(tarfile.open(tarball, 'w')) as spl:
-            for source, target in manifest:
-                # Args here are: name, arcname, recursive, and [exclude|filter]
-                spl.add(source, target, True, exclude)
+        check_call((setup_py, 'build', '--force'), stderr=STDOUT, stdout=sys.stdout)
+        tarball = 'searchcommands_app-{0}-private.tar.gz'.format(self.distribution.metadata.version)
+        source = os.path.join('examples', 'searchcommands_app', 'build', tarball)
+        target = os.path.join('build', tarball)
 
+        shutil.copyfile(source, target)
         return
 
 setup(