Document PyInstall example

jondy · jondy · commit b3d5debcd99c · 2018-11-12T21:03:43.000+08:00
diff --git a/src/examples/README-ZH.md b/src/examples/README-ZH.md
@@ -152,7 +152,7 @@ Pyarmor 的安装路径是 `/path/to/pyarmor`
 
 ```
 
-## 实例 4: 使用第三方发布工具打包加密脚本
+## 实例 4: 使用 py2exe / py2app / cx_Freeze 打包加密脚本
 
 从这个例子中，可以学习到
 
@@ -184,3 +184,54 @@ Pyarmor 的安装路径是 `/path/to/pyarmor`
 的脚本
 
 对于其他打包工具 `cx_Freeze`, `py2app`, 基本使用方法和 `py2exe` 很类似。
+
+## 实例 5: 使用 PyInstaller 打包加密脚本
+
+从这个例子中，可以学习到
+
+* 如何使用第三方工具 `PyInstaller` 来打包加密的脚本
+
+如果没有安装 `pyinstaller`, 运行下面的命令进行安装
+
+    pip install pyinstaller
+    
+这个例子会使用 `PyInstaller` 来发布加密脚本，并最终生成一个可执行文件。
+主脚本是位于 `examples/testmod` 的 [hello.py](testmod/hello.py)。
+
+首先把目录 `testmod` 下面的所有 `.py` 文件加密，存放到 `dist/obf`
+
+    pyarmor obfuscate --src testmod --entry hello.py --no-restrict --output dist/obf
+
+接着先运行 `pyinsntaller` 打包没有加密的脚本到目录 `dist/hello`，这条命
+令同时会生成相应的 `hello.spec`文件
+
+    cd /path/to/pyarmor/examples
+    pyinstaller testmod/hello.py
+
+编辑文件 `hello.spec`, 修改里面的 `Analysis` 对象 `a`，增加加密脚本和运
+行加密脚本需要的辅助文件到数据文件里面
+
+    a = Analysis(['testmod/hello.py', 'dist/obf/hello.py'],
+                 pathex=['/path/to/pyarmor/examples],
+                 datas=[('dist/obf/*.lic', '.'), ('dist/obf/*.key', '.'), ('dist/obf/_pytransform.*', '.')],
+
+在 `Analysis` 之后，在插入一段代码，告诉 `PyInstaller` 把加密后的脚本打
+进包里面，不要使用原来的脚本
+
+    a.scripts[0] = 'hello', 'dist/obf/hello.py', 'PYSOURCE'
+    for i in range(len(a.pure)):
+        if a.pure[i][1].startswith(a.pathex[0]):
+            a.pure[i] = a.pure[i][0], a.pure[i][1].replace('/testmod/', '/dist/obf/'), a.pure[i][2]
+
+使用修正版 `hello.spec` 重新运行 `pyinstaller` 进行打包
+
+    pyinstaller hello.spec
+
+最后运行打包好的可执行文件，把 `license.lic` 删除之后看看能否运行，确保
+打包的是加密脚本
+
+    dist/hello/hello
+
+    rm dist/hello/license.lic
+    dist/hello/hello
+
diff --git a/src/examples/README.md b/src/examples/README.md
@@ -196,3 +196,44 @@ obfuscated scripts are copied here, and the `library.zip` is updated, the
 original `queens.pyc` replaced with obfuscated one.
 
 For cx_Freeze and py2app, it's almost same as py2exe.
+
+## Example 5: Build for PyInstaller
+
+Here is one of workaround to pack obfuscated scripts with `PyInstaller`, this
+example will distribute a script `hello.py` and moudle file `queens.py`
+
+First obfuscate all the `.py` file in the path `testmod` to `dist/obf`
+
+    pyarmor obfuscate --src testmod --entry hello.py --no-restrict --output dist/obf
+
+Then run pyinstaller to build the bundle to `dist/hello/`, this command will
+generate `hello.spec` either
+
+    cd /path/to/pyarmor/examples
+    pyinstaller testmod/hello.py
+
+Edit `hello.spec`, change `Analysis`, add obfuscated script and date files as
+the following way
+
+    a = Analysis(['testmod/hello.py', 'dist/obf/hello.py'],
+                 datas=[('dist/obf/*.lic', '.'), ('dist/obf/*.key', '.'), ('dist/obf/_pytransform.*', '.')],
+
+After `Analysis`, insert code to replace original python scrips and moudles with
+obfuscated ones
+
+    a.scripts[0] = 'hello', 'dist/obf/hello.py', 'PYSOURCE'
+    for i in range(len(a.pure)):
+        if a.pure[i][1].startswith(a.pathex[0]):
+            a.pure[i] = a.pure[i][0], a.pure[i][1].replace('/testmod/', '/dist/obf/'), a.pure[i][2]
+
+Next run pyinstaller with this `hello.spec`
+
+    pyinstaller hello.spec
+
+Finally run exetuable with obfuscated scripts
+
+    dist/hello/hello
+
+    # Check the scripts are obfuscated
+    rm dist/hello/license.lic
+    dist/hello/hello
diff --git a/src/user-guide.md b/src/user-guide.md
@@ -11,10 +11,11 @@ This is the documentation for Pyarmor 3.4 and later.
     - [Use Project to Manage Obfuscated Scripts](#use-project-to-manage-obfuscated-scripts)
         - [Standalone Package](#standalone-package)
         - [Package Used by Outer Scripts](#package-used-by-outer-scripts)
-        - [Pack Obfuscated Scripts with py2exe and cx_Freeze](#pack-obfuscated-scripts-with-py2exe-and-cx_freeze)
         - [Many Obfuscated Package Within Same Python Interpreter](#many-obfuscated-package-within-same-python-interpreter)
         - [Change Default Project Configuration](#change-default-project-configuration)
     - [Distribute Obfuscated Scripts](#distribute-obfuscated-scripts)
+      - [Pack Obfuscated Scripts with py2exe and cx_Freeze](#pack-obfuscated-scripts-with-py2exe-and-cx_freeze)
+      - [Pack Obfuscated Scripts with PyInstaller](#pack-obfuscated-scripts-with-pyinstaller)
     - [License of Obfuscated Scripts](#license-of-obfuscated-scripts)
     - [Cross Platform](#cross-platform)
     - [Use runtime path](#use-runtime-path)
@@ -254,38 +255,6 @@ it used by clear script `examples/testpkg/main.py`
     python main.py
 ```
 
-#### Pack Obfuscated Scripts with py2exe and cx_Freeze
-
-From v4.4, introduces a command `pack` to pack obfuscated scripts with py2exe,
-cx_Freeze etc.
-
-First install py2xe
-
-    pip install py2exe
-
-Then write `setup.py` for py2exe, here is an example script
-`examples/py2exe/setup.py`. There are 2 scripts in this example, entry script
-`hello.py` and `queens.py`. To be sure it works
-
-    cd examples/py2exe
-    python setup.py py2exe
-
-After that, run command `pack` to pack obfuscated scripts
-
-    python pyarmor.py pack --type py2exe examples/py2exe/hello.py
-
-Check the output path of `examples/py2exe/dist`, the runtime files required by
-obfuscated scripts are copied here, and the `library.zip` is updated, the
-original `queens.pyc` replaced with obfuscated one.
-
-For cx_Freeze, py2app, it's almost same as py2exe. Learn more options
-about command [pack](#pack)
-
-Quick start from the following template scripts
-
-* [pack-obfuscated-scripts.bat](examples/pack-obfuscated-scripts.bat) for Windows
-* [pack-obfuscated-scripts.sh](examples/pack-obfuscated-scripts.sh) for most of others
-
 #### Many Obfuscated Package Within Same Python Interpreter
 
 Suppose there are 3 odoo modules `web-login1`, `web-login2`,
@@ -444,6 +413,79 @@ For package which used by other scripts:
 machine. To be exact, the magic string value used to recognize
 byte-compiled code files (.pyc files) must be same.
 
+#### Pack Obfuscated Scripts with py2exe and cx_Freeze
+
+From v4.4, introduces a command `pack` to pack obfuscated scripts with py2exe,
+cx_Freeze etc.
+
+First install py2xe
+
+    pip install py2exe
+
+Then write `setup.py` for py2exe, here is an example script
+`examples/py2exe/setup.py`. There are 2 scripts in this example, entry script
+`hello.py` and `queens.py`. To be sure it works
+
+    cd examples/py2exe
+    python setup.py py2exe
+
+After that, run command `pack` to pack obfuscated scripts
+
+    python pyarmor.py pack --type py2exe examples/py2exe/hello.py
+
+Check the output path of `examples/py2exe/dist`, the runtime files required by
+obfuscated scripts are copied here, and the `library.zip` is updated, the
+original `queens.pyc` replaced with obfuscated one.
+
+For cx_Freeze, py2app, it's almost same as py2exe. Learn more options
+about command [pack](#pack)
+
+Quick start from the following template scripts
+
+* [pack-obfuscated-scripts.bat](examples/pack-obfuscated-scripts.bat) for Windows
+* [pack-obfuscated-scripts.sh](examples/pack-obfuscated-scripts.sh) for most of others
+
+#### Pack Obfuscated Scripts with PyInstaller
+
+Here is one of workaround to pack obfuscated scripts with `PyInstaller`, this
+example will distribute a script `hello.py` and moudle file `queens.py`
+
+First obfuscate all the `.py` file in the path `testmod` to `dist/obf`
+
+    pyarmor obfuscate --src testmod --entry hello.py --no-restrict --output dist/obf
+
+Then run pyinstaller to build the bundle to `dist/hello/`, this command will
+generate `hello.spec` either
+
+    cd /path/to/pyarmor/examples
+    pyinstaller testmod/hello.py
+
+Edit `hello.spec`, change `Analysis`, add obfuscated script and date files as
+the following way
+
+    a = Analysis(['testmod/hello.py', 'dist/obf/hello.py'],
+                 datas=[('dist/obf/*.lic', '.'), ('dist/obf/*.key', '.'), ('dist/obf/_pytransform.*', '.')],
+
+After `Analysis`, insert code to replace original python scrips and moudles with
+obfuscated ones
+
+    a.scripts[0] = 'hello', 'dist/obf/hello.py', 'PYSOURCE'
+    for i in range(len(a.pure)):
+        if a.pure[i][1].startswith(a.pathex[0]):
+            a.pure[i] = a.pure[i][0], a.pure[i][1].replace('/testmod/', '/dist/obf/'), a.pure[i][2]
+
+Next run pyinstaller with this `hello.spec`
+
+    pyinstaller hello.spec
+
+Finally run exetuable with obfuscated scripts
+
+    dist/hello/hello
+
+    # Check the scripts are obfuscated 
+    rm dist/hello/license.lic
+    dist/hello/hello
+
 ### License of Obfuscated Scripts
 
 There is a file `license.lic` in the output path "dist", the default
