Freeze your script with Pyinstaller

[masoudr]

Hi,
You might want to freeze your script into a standalone executable to run on any system without the need of installing python or face_recognition and maybe you want to create a demo for your application and want to give it to someone else without giving your source code. Here is a simple tutorial to do that. I tested this method with python3.6 on Windows 10, but I think you can get it working on Linux with a similar method.

1. Make sure you have correctly installed both face_recognition and dlib and you see no error when importing them into your script.
2. Make sure your script works fine, and all its dependencies are right next to it, and you can run it fine with python yourscript.py.
3. Install Pyinstaller with pip:
   pip install pyinstaller
4. Create a new directory and move your python script and all dependencies into it. I call it myproject and myscript.py
5. Copy face_recognition_models and scipy-extra-dll from your python installed directory to your project directory.
6. Create an empty file called <yourscriptname>.spec like myscript.spec next to your python script.
7. Use below Pyinstaller spec file sample and edit some parts according to your needs: (I mark it with <> tag)

# -*- mode: python -*-

block_cipher = None

face_models = [
('.\\face_recognition_models\\models\\dlib_face_recognition_resnet_model_v1.dat', './face_recognition_models/models'),
('.\\face_recognition_models\\models\\mmod_human_face_detector.dat', './face_recognition_models/models'),
('.\\face_recognition_models\\models\\shape_predictor_5_face_landmarks.dat', './face_recognition_models/models'),
('.\\face_recognition_models\\models\\shape_predictor_68_face_landmarks.dat', './face_recognition_models/models'),
]

a = Analysis(['<your python script name.py>'],
             pathex=['<path to working directory>'],
             binaries=face_models,
             datas=[],
             hiddenimports=['scipy._lib.messagestream', 'scipy', 'scipy.signal', 'scipy.signal.bsplines', 'scipy.special', 'scipy.special._ufuncs_cxx',
                            'scipy.linalg.cython_blas',
                            'scipy.linalg.cython_lapack',
                            'scipy.integrate',
                            'scipy.integrate.quadrature',
                            'scipy.integrate.odepack',
                            'scipy.integrate._odepack',
                            'scipy.integrate.quadpack',
                            'scipy.integrate._quadpack',
                            'scipy.integrate._ode',
                            'scipy.integrate.vode',
                            'scipy.integrate._dop', 'scipy._lib', 'scipy._build_utils','scipy.__config__',
                            'scipy.integrate.lsoda', 'scipy.cluster', 'scipy.constants','scipy.fftpack','scipy.interpolate','scipy.io','scipy.linalg','scipy.misc','scipy.ndimage','scipy.odr','scipy.optimize','scipy.setup','scipy.sparse','scipy.spatial','scipy.special','scipy.stats','scipy.version'],

             hookspath=[],
             runtime_hooks=[],
             excludes=[],
             win_no_prefer_redirects=False,
             win_private_assemblies=False,
             cipher=block_cipher)

a.datas += Tree('./scipy-extra-dll', prefix=None)

pyz = PYZ(a.pure, a.zipped_data,
             cipher=block_cipher)
exe = EXE(pyz,
          a.scripts,
          a.binaries,
          a.zipfiles,
          a.datas,
          name='<your python script name>',
          debug=False,
          strip=False,
          upx=True,
          runtime_tmpdir=None,
          console=True )

8. Generate your executable with python -m pyinstaller myscript.spec
9. If you see no error then your executable can be found in dist directory.
10. Enjoy!

Thanks to @ageitgey and @davisking for their awesome work.

[ageitgey]

Cool, thanks for sharing!

[vgreis]

I found this worked very well when running on Windows desktop, but the application would crash on Windows Server 2012 - 2016 with an unhelpful, vague unable to execute DLL error. I found this issue was caused by using the latest version of dlib linked in the project install guide under issue 175 (currently 19.9.99). However, by using 'pip install dlib', which installs 19.9.0 (again, currently as of writing this). The frozen executable is running without errors on both desktop and server. I've also been testing freezing this in both 32-bit and 64-bit python and both are working. Thanks

[masoudr]

@vgreis I haven't tested Pyinstaller with the new version of dlib but I think you can get it working by just add the missing DLL's to binaries it will then be extracted when running the app and again remember that it doesn't matter if you install dlib by source or pip, just make sure your installation is successful.

[mariocesarc]

Thanks! It works

[inewlife]

Incompatible library version: dlib.so requires version 51.0.0 or later, but libpng16.16.dylib provides version 38.0.0

[masoudr]

@inewlife Can you post the complete error log? I haven't tested this method with the new version of dlib but I think it is not related because what you need here is just adding scipy and face_recognition_modules manually not the dlib itself.

[fordffx]

I did as what the first floor told,but still got this:
Traceback (most recent call last):
File "C:\PyInstaller-3.3.1\temp_classroom.py", line 16, in
import face_recognition
File "", line 961, in _find_and_load
File "", line 950, in _find_and_load_unlocked
File "", line 655, in load_unlocked
File "C:\PyInstaller-3.3.1\PyInstaller\loader\pyimod03_importers.py", line 631
, in exec_module
exec(bytecode, module.dict)
File "C:\ProgramData\Anaconda3\Lib\site-packages\face_recognition_init.py"
, line 7, in
from .api import load_image_file, face_locations, batch_face_locations, face
_landmarks, face_encodings, compare_faces, face_distance
File "", line 961, in _find_and_load
File "", line 950, in _find_and_load_unlocked
File "", line 655, in _load_unlocked
File "C:\PyInstaller-3.3.1\PyInstaller\loader\pyimod03_importers.py", line 631
, in exec_module
exec(bytecode, module.dict)
File "C:\ProgramData\Anaconda3\Lib\site-packages\face_recognition\api.py", lin
e 21, in
pose_predictor_5_point = dlib.shape_predictor(predictor_5_point_model)
RuntimeError: Unable to open C:\Users\ADMINI~1\AppData\Local\Temp_MEI71042\face
_recognition_models\models\shape_predictor_5_face_landmarks.dat
[5948] Failed to execute script temp_classroom

how did the exe file come to this dir ?
and _MEI71042 changes every time the exe file run

when i use nuitka to make exe file ,and it jumped out this as the exe file run :
Please install face_recognition_models with this command before using face_recognition:
pip install git+https://github.com/ageitgey/face_recognition_models
actruly, I did installed them successfully.

thanks

[masoudr]

@fordffx Hi,
As I said in the first post you must first install all dependencies for your python. About the _MEI71042, every time you run the executable pyinstaller tries to extract dependencies in the temp directory and when your program ends without exception it deletes that folder automatically,

[fordffx]

i replaced
datas=[]
with
datas=[('shape_predictor_68_face_landmarks.dat','./face_recognition_models/models'),('shape_predictor_5_face_landmarks.dat','./face_recognition_models/models'),('mmod_human_face_detector.dat','./face_recognition_models/models'),('dlib_face_recognition_resnet_model_v1.dat','./face_recognition_models/models')]
that works,thanks

[roiksail]

thanks for sharing your knowledge...i can't find scipy-extra-dll ...how i can to find them in python directory??i am in ubuntu 16.04,
thank you in advance

[masoudr]

@roiksail Hi, dll files are not made for Linux systems so you can't find any. I think you don't need to add scipy dependencies. Just build your binary file and try to run it. If It complains about some files just find that and add it manually like above method. That is it.

[roiksail]

thank you,how i change myscript.spec file??

…

On Tue, Apr 10, 2018 at 10:19 PM, Masoud R. ***@***.***> wrote: @roiksail <https://github.com/roiksail> Hi, dll files are not made for Linux systems so you can't find any. I think you don't need to add scipy dependencies. Just build your binary file and try to run it. If It complains about some files just find that and add it manually like above method. That is it. — You are receiving this because you were mentioned. Reply to this email directly, view it on GitHub <#357 (comment)>, or mute the thread <https://github.com/notifications/unsubscribe-auth/Ahjqp8SBtcZj6ua74UNX5VENf0B4MbY4ks5tnPCdgaJpZM4SBU9b> .

[masoudr]

@roiksail First you need to freeze your script with pyinstaller script.py then the spec file should be generated next to your script file.

[roiksail]

thank you so much,i mmaked executable application in ubuntu but when i copied this file in ubuntu then it was simply file and it does not executed,how i fix this??

[masoudr]

@roiksail I think you need to find out what is Pyinstaller and how to use it in from here. In general, after you run the command you should find the executable with the exact name of the script. I think Pyinstaller will make the file as executable binary so you can just use ./yourscriptname command and if it didn't work try to make it executable with sudo chmod +x yourscriptname. That is it.