Using PyInstaller (or similar) to create an executable

SimonBiggs · December 2, 2020, 11:04pm

I took a different approach to this. I used pyinstaller to create the single file exe, but the resulting Python used was actually a separate install, not the one made by pyinstaller. That’s so that my users can create new streamlit apps and use new sections of the dependencies that I wasn’t using. (Given pyinstaller would have stripped those out).

To see a demo of the exe see:

When first clicking it, it will unpack the distro. Subsequent clicks should be much quicker to boot. I need to make the terminal give the user some details and provide functionality for updates etc. But in its current form it is usable.

The script used to make that exe can be found over at:

github.com

pymedphys/pymedphys/blob/4886291f1b812f29066dbc232f77bea08ef58866/binary/build-binary.py

# Copyright (C) 2020 Simon Biggs

# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at

#     http://www.apache.org/licenses/LICENSE-2.0

# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.

import pathlib
import subprocess
import shutil
import sys
import urllib.request
import zipfile

This file has been truncated. show original

And here is the pyinstaller magic. The following script is what pyinstaller is pointed to. It sees if the full streamlit python distro has been extracted, if it has it boots up streamlit in there, if it hasn’t it extracts it before doing so:

github.com

pymedphys/pymedphys/blob/4886291f1b812f29066dbc232f77bea08ef58866/binary/pyinstaller-bundle-script.py

# Copyright (C) 2020 Simon Biggs

# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at

#     http://www.apache.org/licenses/LICENSE-2.0

# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.

import os
import subprocess
import sys
import pathlib
import tarfile
import shutil

This file has been truncated. show original

This whole approach should be easier now that I suspect the following PR has just released within 0.72.0:

All that will be required now is changing the following line:

github.com

pymedphys/pymedphys/blob/4886291f1b812f29066dbc232f77bea08ef58866/binary/pyinstaller-bundle-script.py#L89


def _boot_streamlit_app(python_embedded_directory):
    """Starts the PyMedPhys GUI within the Python embedded distribution.
    Parameters
    ----------
    python_embedded_directory
        The full path to the Python embedded distribution.
    """
    subprocess.check_call(
        "python.exe -m pymedphys gui", cwd=python_embedded_directory, shell=True
    )
if __name__ == "__main__":
    main()

To calling “python.exe -m streamlit run path/to/your-app.py”

Topic		Replies	Views
Creating executable file for a multipage Streamlit app Using Streamlit	2	4310	January 10, 2024
Packaging a Streamlit app Deployment docker , pyinstaller	5	6325	November 19, 2021
Running Streamlit inside my own executable with the "click" module Using Streamlit	5	9754	November 19, 2021
How to most easily share your streamlit app locally? Deployment pyinstaller	41	46511	March 20, 2024
How to pack the app by pyinstaller Random pyinstaller	4	1834	October 29, 2023

Using PyInstaller (or similar) to create an executable

Related topics

Hello there 👋🏻

Cookie settings

Strictly necessary cookies

Performance cookies

Functional cookies

Targeting cookies