cleaned up all files and set version to 0.1

Author: scriptingosx

README.md

@@ -1,4 +1,32 @@
-# quickpkg
+# `quickpkg`
+
+This tool will quickly and easily build a package from an installed application, a disk image file or zip archive with an enclosed application bundle. It will also extract the application name and version and use it to name the resulting `pkg` file. 
+
+The tool will look for applications on the first level of the disk image or archive. If it finds no or more than one application it will error.
+
+The name of the resulting package will be of the form `{name}-{version}.pkg`. Spaces will be removed from the name. The package will be written to the current working directory.
+
+## Examples
+
+Build package from installed application:
+
+```
+quickpkg /Applications/Numbers.app
+```
+
+Build package from a disk image:
+
+```
+quickpkg ~/Downloads/Firefox\ 43.0.4.dmg
+```
+
+Build package from a zip archive:
+
+```
+quickpkg ~/Downloads/Things.zip
+```
+
+## Background
 
 OS X has had the `pkgbuild` tool since Xcode 3.2 on Snow Leopard. With pkgbuild you can directly build a installer package from an application in the `/Applications` folder:
 
@@ -16,4 +44,14 @@ pkgbuild --component /Volumes/Firefox/Firefox.app \
 
 This tool even does the work of determining a bundle's identifier and version and sets the identifier and version of the pkg to the same values.
 
-However, `pkgbuild` does not 
+However, `pkgbuild` does not automatically name the package.
+
+## `quickpkg` vs `autopkg`
+
+This tool is not meant to replace [`autopkg`](https://github.com/autopkg/autopkg). `autopkg` will automate the download, the re-packaging (if necessary) and the upload to and configuration of your client management system. It can also handle much more complex setups than `quickpkg`. `autopkg` is far superior and should be your tool of choice.
+
+However, there are situations where `autopkg` does not work well. The most common reason is if the download cannot be automated because the download page is behind a paywall. Also `autopkg` requires a recipe for a given piece of software. If no recipe exists, `quickpkg` may be a simple alternative. (Though if `quickpkg` works, creating an `autopkg` recipe should not be hard.) 
+
+## Warning
+
+All `quickpkg` does is identify an application bundle and package it in a way that the package will install that application bundle into the `/Applications` folder. If the application needs other files (libraries, frameworks, configuration files, license files, preferences etc.) to run and work they are your responsibility. 

quickpkg

@@ -9,7 +9,7 @@ import tempfile
 import shutil
 
 
-quickpkg_version = '0.0'
+quickpkg_version = '0.1'
 supported_extensions = ['dmg', 'app', 'zip']
 
 # quickpkg
@@ -118,16 +118,17 @@ def appNameAndVersion(app_path):
     app_name = info_plist.get("CFBundleName", None)
     app_identifier = info_plist.get("CFBundleIdentifier", None)
     app_version = info_plist.get("CFBundleShortVersionString", None)
-    if app_version == None:
+    if app_version is None:
         app_version = info_plist.get("CFBundleVersion", None)
     return (app_name, app_identifier, app_version)
 
 
 if __name__ == "__main__":
+
     # for convenience link to argparse tutorial:
     # https://docs.python.org/2/howto/argparse.html#id1
     parser = argparse.ArgumentParser(description="Attempts to build a pkg from the input.",
-                                     epilog="""Installer item can be a dmg, or app.
+                                     epilog="""Installer item can be a dmg, zip, or app.
 
         Example:
         quickpkg /path/to/installer_item""", formatter_class=argparse.RawTextHelpFormatter)
@@ -162,6 +163,7 @@ if __name__ == "__main__":
         app_path = item_path
 
     dmgvolumepaths = []
+    tmp_path = None
 
     # if item is a dmg, mount it and find useful contents
     if item_extension == 'dmg':
@@ -179,7 +181,7 @@ if __name__ == "__main__":
             print foundapps
             detachpaths(dmgvolumepaths)
             exit(1)
-        
+
         app_path = foundapps[0]
 
     # if item is zip, unzip to tmp location and find useful contents
@@ -201,19 +203,19 @@ if __name__ == "__main__":
             print foundapps
             shutil.rmtree(tmp_path)
             exit(1)
-        
+
         app_path = foundapps[0]
 
     logger("Found application: %s" % app_path, 1)
-    
+
     # extract version and other metadata
     (app_name, app_identifier, app_version) = appNameAndVersion(app_path)
 
-    logger("Name: %s, ID: %s, Version: %s" %(app_name, app_identifier, app_version))
+    logger("Name: %s, ID: %s, Version: %s" % (app_name, app_identifier, app_version))
 
     # TODO: get name syntax from prefs or parameter
     pkg_name = "{name}-{version}.pkg".format(name=app_name, version=app_version, identifier=app_identifier)
-    pkg_name = pkgname.replace(' ', '') # remove spaces
+    pkg_name = pkg_name.replace(' ', '')  # remove spaces
     # run pkgutil to build result
 
     pkgcmd = ["/usr/bin/pkgbuild",
@@ -232,4 +234,5 @@ if __name__ == "__main__":
         print pkg_name
 
     detachpaths(dmgvolumepaths)
-
+    if tmp_path is not None:
+        shutil.rmtree(tmp_path)

todo.txt

@@ -1,15 +1,16 @@
 - deal with agreements in dmgs (Evernote has one)
 - deal with already mounted dmgs
+- use some preference setting to determine package name syntax
 - add option to add scripts
 √ look into and decompress zip files
-- support for tar, gzip and bzip
 - build packages from filelists
 - use file lists from composer files
-- identify app just by name or id
+- add option to build a munki-pkg project folder rather than build a package
+- signature support
 - identify shell scripts and build a payload free package
 - identify mobileconfigs and build a package installer
-- signature support
 - other possible file formats: fonts, prefpanes, Safari extensions?
-- use some preference setting to determine package name syntax
-- add option to build a munki-pkg project folder rather than build a package
 √ remove spaces from pkg_name
+- support the --ownership flag
+- support for tar, gzip and bzip
+- identify app just by name or id (could use: mdfind "kMDItemKind == 'Application' && kMDItemDisplayName == 'iTunes'")