STYLE: Only output downloadable .zip archives for examples

Keep it simple and do not also generation .tar.gz tarballs.

Make sure to also add the .ipynb notebooks.

Author: thewtex

CMake/ITKSphinxExamplesMacros.cmake

@@ -1,8 +1,8 @@
 include(CMakeParseArguments)
 
 # A high level target that the individual targets depend on.
-#add_custom_target( CreateTarballs ALL
-#  ${CMAKE_COMMAND} -E echo "Done creating individual example tarballs..."
+#add_custom_target( CreateDownloadableArchives ALL
+#  ${CMAKE_COMMAND} -E echo "Done creating individual example downloadable archives..."
 #)
 
 # Macro for adding an example.
@@ -11,20 +11,20 @@ include(CMakeParseArguments)
 # CMakeLists.txt.  That file should be standalone for building the example.
 # This macro is intended to be instantiated in the CMakeLists.txt one directory
 # above where the example exists.  It does things like creating the example
-# tarball's in the example output directory, and custom targets for building
+# archives's in the example output directory, and custom targets for building
 # the Sphinx documentation for an individual example.  The Sphinx target will be
 # called ${example_name}Doc.
 macro(add_example example_name)
   if(BUILD_DOCUMENTATION)
     if(SPHINX_HTML_OUTPUT)
-      add_custom_target(${example_name}Tarball
-        COMMAND ${PYTHON_EXECUTABLE} ${ITKSphinxExamples_SOURCE_DIR}/Utilities/CreateTarball.py
+      add_custom_target(${example_name}DownloadableArchive
+        COMMAND ${PYTHON_EXECUTABLE} ${ITKSphinxExamples_SOURCE_DIR}/Utilities/CreateDownloadableArchive.py
           ${example_name} ${SPHINX_DESTINATION}
         WORKING_DIRECTORY ${CMAKE_CURRENT_BINARY_DIR}
-        COMMENT "Creating tarballs for ${example_name}"
+        COMMENT "Creating downloadable archive for ${example_name}"
         DEPENDS copy_sources
         )
-      add_dependencies(CreateTarballs ${example_name}Tarball)
+      add_dependencies(CreateDownloadableArchives ${example_name}DownloadableArchive)
     endif()
   endif()
 

CMakeLists.txt

@@ -262,8 +262,8 @@ if(BUILD_DOCUMENTATION)
   add_dependencies(gitstats copy_sources)
 
   # A high level target that the individual targets depend on.
-  add_custom_target(CreateTarballs ALL
-    ${CMAKE_COMMAND} -E echo "Done creating individual example tarballs..."
+  add_custom_target(CreateDownloadableArchives ALL
+    ${CMAKE_COMMAND} -E echo "Done creating individual example downloadable archives..."
     )
 
   if(NOT ITKDoxygenXML_DIR)
@@ -282,7 +282,7 @@ if(BUILD_DOCUMENTATION)
   set(SPHINX_CONF_DIR ${ITKSphinxExamples_BINARY_DIR}/Formatting)
   set(SPHINX_INPUT_DIR ${ITKSphinxExamples_BINARY_DIR})
   set(SPHINX_DESTINATION ${ITKSphinxExamples_BINARY_DIR})
-  set(SPHINX_DEPENDENCIES gitstats ITKDoxygenXML ITKSphinxExamplesData ITKDoxygenTAG CreateTarballs)
+  set(SPHINX_DEPENDENCIES gitstats ITKDoxygenXML ITKSphinxExamplesData ITKDoxygenTAG CreateDownloadableArchives)
 
   option(DOC_WITH_LOCAL_DOXYGEN "Generate documentation with local doxygen" OFF)
   mark_as_advanced(DOC_WITH_LOCAL_DOXYGEN)

Utilities/CreateTarball.py renamed to Utilities/CreateDownloadableArchive.py

@@ -1,6 +1,6 @@
 #!/usr/bin/env python
 
-""" Build tarballs for the examples.
+""" Build archives for the examples.
 
 Build the .tar.gz and .zip for the example, and copy them along with the
 supporting files into the html output.
@@ -12,7 +12,6 @@
 import os
 import shutil
 import sys
-import tarfile
 import zipfile
 from pathlib import Path
 
@@ -26,6 +25,7 @@
 
 example_name = sys.argv[1]
 base_dir = cwd.parent.parent.parent
+example_dir = str(cwd / example_name)
 example_relative_path = cwd.relative_to(base_dir) / example_name
 html_output_dir = str(Path(sys.argv[2]) / "html" / example_relative_path)
 
@@ -38,68 +38,51 @@
 files_to_copy_to_html_output.extend(glob.glob(os.path.join(example_dir, "*.cxx")))
 files_to_copy_to_html_output.extend(glob.glob(os.path.join(example_dir, "*.html")))
 files_to_copy_to_html_output.extend(glob.glob(os.path.join(example_dir, "*.py")))
+files_to_copy_to_html_output.extend(glob.glob(os.path.join(example_dir, "*.ipynb")))
 files_to_copy_to_html_output.extend(glob.glob(os.path.join(example_dir, "*.rst")))
 for path in files_to_copy_to_html_output:
     shutil.copy2(path, html_output_dir)
 
 
-# Tarballs for users to download from the website.
-files_for_tarball = files_to_copy_to_html_output
+# archives for users to download from the website.
+files_for_archive = files_to_copy_to_html_output
 
 # Add a directory to build the project.
 build_dir = os.path.join(example_dir, "build")
 if not os.path.exists(build_dir):
     os.mkdir(build_dir)
-files_for_tarball.append(build_dir)
+files_for_archive.append(build_dir)
 
 # Substitude CMAKE_CURRENT_BINARY_DIR for CMAKE_CURRENT_SOURCE_DIR in the
-# tarball CMakeLists.txt.  This so the input images can be found.
-tarball_cmakelist = os.path.join(example_dir, "CMakeLists.txt.tarball")
-with open(tarball_cmakelist, "w") as new_list_file:
+# archive CMakeLists.txt.  This so the input images can be found.
+archive_cmakelist = os.path.join(example_dir, "CMakeLists.txt.archive")
+with open(archive_cmakelist, "w") as new_list_file:
     with open(os.path.join(example_dir, "CMakeLists.txt"), "r") as old_list_file:
         for line in old_list_file:
             newline = line.replace(
                 "CMAKE_CURRENT_BINARY_DIR", "CMAKE_CURRENT_SOURCE_DIR"
             )
             new_list_file.write(newline)
-files_for_tarball = files_for_tarball[1:]
-files_for_tarball.append(tarball_cmakelist)
+files_for_archive = files_for_archive[1:]
+files_for_archive.append(archive_cmakelist)
 
 inputs = glob.glob(os.path.join(example_dir, "*.sha512"))
 for path in inputs:
-    files_for_tarball.append(path[:-7])
+    files_for_archive.append(path[:-7])
 
 # Remove duplicates.
-files_for_tarball = set(files_for_tarball)
-
-with tarfile.open(
-    os.path.join(html_output_dir, example_name + ".tar.gz"), "w:gz", dereference=True
-) as tarfile:
-    example_dir_idx = example_dir.index(example_name)
-
-    def strip_path(tarinfo):
-        tarinfo.name = tarinfo.name[example_dir_idx - 1 :]
-        # Put the inputs and outputs into the build directory because the test
-        # will not be able to find them otherwise.
-        basename = os.path.basename(tarinfo.name)
-        if basename == "CMakeLists.txt.tarball":
-            head, tail = os.path.split(tarinfo.name)
-            tarinfo.name = os.path.join(head, "CMakeLists.txt")
-        return tarinfo
-
-    for path in files_for_tarball:
-        tarfile.add(path, filter=strip_path)
+files_for_archive = set(files_for_archive)
 
 with zipfile.ZipFile(
     os.path.join(html_output_dir, example_name + ".zip"), "w"
 ) as zipfile:
     example_dir_idx = example_dir.index(example_name)
-    for path in files_for_tarball:
+    for path in files_for_archive:
         arcname = path[example_dir_idx - 1 :]
         # Put the inputs and outputs into the build directory because the test
         # will not be able to find them otherwise.
         basename = os.path.basename(arcname)
-        if basename == "CMakeLists.txt.tarball":
+        if basename == "CMakeLists.txt.archive":
             head, tail = os.path.split(arcname)
             arcname = os.path.join(head, "CMakeLists.txt")
         zipfile.write(path, arcname)