Merge pull request #18 from sommersoft/examples

Add Examples To Bundles

Author: tannewt

circuitpython_build_tools/build.py

@@ -92,18 +92,25 @@ def _munge_to_temp(original_path, temp_file, library_version):
             temp_file.write(line.encode("utf-8") + b"\r\n")
     temp_file.flush()
 
-def library(library_path, output_directory, mpy_cross=None):
+def library(library_path, output_directory, mpy_cross=None, example_bundle=False):
     py_files = []
     package_files = []
+    example_files = []
     total_size = 512
     for filename in os.listdir(library_path):
         full_path = os.path.join(library_path, filename)
-        if os.path.isdir(full_path) and filename not in ["examples", "docs"]:
+        if os.path.isdir(full_path) and filename not in ["docs"]:
             files = os.listdir(full_path)
             files = filter(lambda x: x.endswith(".py"), files)
             files = map(lambda x: os.path.join(filename, x), files)
-            package_files.extend(files)
-        if filename.endswith(".py") and filename not in IGNORE_PY:
+            if filename.startswith("examples"):
+                example_files.extend(files)
+            else:
+                if not example_bundle:
+                    package_files.extend(files)
+        if (filename.endswith(".py") and
+           filename not in IGNORE_PY and
+           not example_bundle):
             py_files.append(filename)
 
     if len(py_files) > 1:
@@ -116,7 +123,6 @@ def library(library_path, output_directory, mpy_cross=None):
             os.makedirs(base_dir)
             total_size += 512
 
-
     new_extension = ".py"
     if mpy_cross:
         new_extension = ".mpy"
@@ -163,3 +169,10 @@ def library(library_path, output_directory, mpy_cross=None):
                                                temp_file.name])
                 if mpy_success != 0:
                     raise RuntimeError("mpy-cross failed on", full_path)
+
+    for filename in example_files:
+        full_path = os.path.join(library_path, filename)
+        output_file = os.path.join(output_directory.replace("/lib", "/"), filename)
+        with tempfile.NamedTemporaryFile() as temp_file:
+            _munge_to_temp(full_path, temp_file, library_version)
+            shutil.copyfile(temp_file.name, output_file)

circuitpython_build_tools/scripts/build_bundles.py

@@ -49,37 +49,43 @@ def add_file(bundle, src_file, zip_name):
 
 
 def build_bundle(libs, bundle_version, output_filename,
-        build_tools_version="devel", mpy_cross=None):
+        build_tools_version="devel", mpy_cross=None, example_bundle=False):
     build_dir = "build-" + os.path.basename(output_filename)
-    build_lib_dir = os.path.join(build_dir, "lib")
+    build_lib_dir = os.path.join(build_dir, build_dir.replace(".zip", ""), "lib")
+    build_example_dir = os.path.join(build_dir, build_dir.replace(".zip", ""), "examples")
     if os.path.isdir(build_dir):
         print("Deleting existing build.")
         shutil.rmtree(build_dir)
-    os.makedirs(build_lib_dir)
+    total_size = 0
+    if not example_bundle:
+        os.makedirs(build_lib_dir)
+        total_size += 512
+    os.makedirs(build_example_dir)
+    total_size += 512
 
     multiple_libs = len(libs) > 1
 
     success = True
-    total_size = 512
     for library_path in libs:
         try:
-            build.library(library_path, build_lib_dir, mpy_cross=mpy_cross)
+            build.library(library_path, build_lib_dir, mpy_cross=mpy_cross,
+                          example_bundle=example_bundle)
         except ValueError as e:
-            print(library_path)
+            print("build.library failure:", library_path)
             print(e)
             success = False
 
     print()
     print("Generating VERSIONS")
     if multiple_libs:
-        with open(os.path.join(build_lib_dir, "VERSIONS.txt"), "w") as f:
+        with open(os.path.join(build_dir, build_dir.replace(".zip", ""), "VERSIONS.txt"), "w") as f:
             f.write(bundle_version + "\r\n")
-            versions = subprocess.run('git submodule foreach \"git remote get-url origin && git describe --tags\"', shell=True, stdout=subprocess.PIPE)
+            versions = subprocess.run('git submodule foreach \"git remote get-url origin && git describe --tags\"', shell=True, stdout=subprocess.PIPE, cwd=os.path.commonpath(libs))
             if versions.returncode != 0:
                 print("Failed to generate versions file. Its likely a library hasn't been "
                       "released yet.")
                 success = False
-            
+
             repo = None
             for line in versions.stdout.split(b"\n"):
                 if line.startswith(b"Entering") or not line:
@@ -103,7 +109,7 @@ def build_bundle(libs, bundle_version, output_filename,
         bundle.comment = json.dumps(build_metadata).encode("utf-8")
         if multiple_libs:
             total_size += add_file(bundle, "README.txt", "lib/README.txt")
-        for root, dirs, files in os.walk(build_lib_dir):
+        for root, dirs, files in os.walk(build_dir):
             ziproot = root[len(build_dir + "/"):].replace("-", "_")
             for filename in files:
                 total_size += add_file(bundle, os.path.join(root, filename),
@@ -146,11 +152,14 @@ def build_bundles(filename_prefix, output_directory, library_location, library_d
     with open(build_tools_fn, "w") as f:
         f.write(build_tools_version)
 
+    # Build raw source .py bundle
     zip_filename = os.path.join(output_directory,
         filename_prefix + '-py-{VERSION}.zip'.format(
             VERSION=bundle_version))
     build_bundle(libs, bundle_version, zip_filename,
                  build_tools_version=build_tools_version)
+
+    # Build .mpy bundle(s)
     os.makedirs("build_deps", exist_ok=True)
     for version in target_versions.VERSIONS:
         # Use prebuilt mpy-cross on Travis, otherwise build our own.
@@ -166,3 +175,10 @@ def build_bundles(filename_prefix, output_directory, library_location, library_d
                 VERSION=bundle_version))
         build_bundle(libs, bundle_version, zip_filename, mpy_cross=mpy_cross,
                      build_tools_version=build_tools_version)
+
+    # Build example bundle
+    zip_filename = os.path.join(output_directory,
+        filename_prefix + '-examples-{VERSION}.zip'.format(
+            VERSION=bundle_version))
+    build_bundle(libs, bundle_version, zip_filename,
+                 build_tools_version=build_tools_version, example_bundle=True)