fix(scripts): adapt scripts so we can expose them thru poetry.

Moved the scripts within the package and renamed them with the right
Python extension. They could not be imported properly before since they
were lacking the .py extension and did not define a main function.

Tested with `poetry build` and `pip install` on the generated wheel
locally against test files from unblob.

Author: qkaiser

pyproject.toml

@@ -34,9 +34,9 @@ exclude = []
 exclude = ["build"]
 
 [tool.poetry.scripts]
-ubireader_display_blocks = "scripts.ubireader_display_blocks:main"
-ubireader_display_info = "scripts.ubireader_display_info:main"
-ubireader_extract_files = "scripts.ubireader_extract_files:main"
-ubireader_extract_images = "scripts.ubireader_extract_images:main"
-ubireader_list_files = "scripts.ubireader_list_files:main"
-ubireader_utils_info = "scripts.ubireader_utils_info:main"
+ubireader_display_blocks = "ubireader.scripts.ubireader_display_blocks:main"
+ubireader_display_info = "ubireader.scripts.ubireader_display_info:main"
+ubireader_extract_files = "ubireader.scripts.ubireader_extract_files:main"
+ubireader_extract_images = "ubireader.scripts.ubireader_extract_images:main"
+ubireader_list_files = "ubireader.scripts.ubireader_list_files:main"
+ubireader_utils_info = "ubireader.scripts.ubireader_utils_info:main"

ubireader/scripts/__init__.py

@@ -0,0 +1 @@
+

scripts/ubireader_display_blocks …ader/scripts/ubireader_display_blocks.pyscripts/ubireader_display_blocks renamed to ubireader/scripts/ubireader_display_blocks.py scripts/ubireader_display_blocks renamed to ubireader/scripts/ubireader_display_blocks.py

@@ -32,8 +32,8 @@
 from ubireader.ubifs.defines import UBIFS_NODE_MAGIC
 from ubireader.utils import guess_filetype, guess_start_offset, guess_leb_size, guess_peb_size
 
-if __name__=='__main__':
 
+def main():
     description = 'Search for specified blocks and display information.'
     usage = """
     ubireader_display_blocks "{'block.attr': value,...}" path/to/image
@@ -188,3 +188,6 @@
 
     for block in blocks:
         print(block.display())
+
+if __name__=='__main__':
+    main()

scripts/ubireader_display_info …reader/scripts/ubireader_display_info.pyscripts/ubireader_display_info renamed to ubireader/scripts/ubireader_display_info.py scripts/ubireader_display_info renamed to ubireader/scripts/ubireader_display_info.py

@@ -31,8 +31,7 @@
 from ubireader.utils import guess_filetype, guess_start_offset, guess_leb_size, guess_peb_size
 from ubireader.ubi_io import ubi_file, leb_virtual_file
 
-
-if __name__=='__main__':
+def main():
     start = time.time()
     description = 'Show information about UBI or UBIFS image.'
     usage = 'ubireader_display_info [options] filepath'
@@ -185,3 +184,6 @@
 
     else:
         print('Something went wrong to get here.')
+
+if __name__=='__main__':
+    main()

scripts/ubireader_extract_files …eader/scripts/ubireader_extract_files.pyscripts/ubireader_extract_files renamed to ubireader/scripts/ubireader_extract_files.py scripts/ubireader_extract_files renamed to ubireader/scripts/ubireader_extract_files.py

@@ -44,8 +44,7 @@ def create_output_dir(outpath):
         except Exception as e:
             error(create_output_dir, 'Fatal', '%s' % e)
 
-
-if __name__=='__main__':
+def main():
     start = time.time()
     description = 'Extract contents of a UBI or UBIFS image.'
     usage = 'ubireader_extract_files [options] filepath'
@@ -198,3 +197,7 @@ def create_output_dir(outpath):
 
     else:
         print('Something went wrong to get here.')
+
+
+if __name__=='__main__':
+    main()

scripts/ubireader_extract_images …ader/scripts/ubireader_extract_images.pyscripts/ubireader_extract_images renamed to ubireader/scripts/ubireader_extract_images.py scripts/ubireader_extract_images renamed to ubireader/scripts/ubireader_extract_images.py

@@ -38,8 +38,7 @@ def create_output_dir(outpath):
         except Exception as e:
             error(create_output_dir, 'Fatal', '%s' % e)
 
-
-if __name__=='__main__':
+def main():
     start = time.time()
     description = 'Extract UBI or UBIFS images from file containing UBI data in it.'
     usage = 'ubireader_extract_images [options] filepath'
@@ -167,3 +166,6 @@ def create_output_dir(outpath):
                 # Loop through and write volume block data (LEB) to file.
                 for block in image.volumes[volume].reader(ubi_obj):
                     f.write(block)
+
+if __name__=='__main__':
+    main()

scripts/ubireader_list_files ubireader/scripts/ubireader_list_files.pyscripts/ubireader_list_files renamed to ubireader/scripts/ubireader_list_files.py

@@ -33,7 +33,7 @@
 from ubireader.debug import error, log
 from ubireader.utils import guess_filetype, guess_start_offset, guess_leb_size, guess_peb_size
 
-if __name__=='__main__':
+def main():
     start = time.time()
     description = 'List and Extract files of a UBI or UBIFS image.'
     usage = 'ubireader_list_files [options] filepath'
@@ -172,3 +172,6 @@
 
     else:
         print('Something went wrong to get here.')
+
+if __name__=='__main__':
+    main()

scripts/ubireader_utils_info ubireader/scripts/ubireader_utils_info.pyscripts/ubireader_utils_info renamed to ubireader/scripts/ubireader_utils_info.py

@@ -237,7 +237,7 @@ def make_files(ubi, outpath):
             fscr.write(buf)
         os.chmod(script_path, 0o755)
 
-if __name__=='__main__':
+def main():
     start = time.time()
     description = 'Determine settings for recreating UBI image.'
     usage = 'ubireader_utils_info [options] filepath'
@@ -343,3 +343,5 @@ def make_files(ubi, outpath):
         # Create build scripts.
         make_files(ubi_obj, outpath)
 
+if __name__=='__main__':
+    main()