Installation¶
In a virtual environment, install by issuing the command:
pip install --upgrade cx_Freeze
Without virtual environment, depending on the system:
python -m pip install --upgrade cx_Freeze
or
python3 -m pip install --upgrade cx_Freeze
Python requirements¶
Python requirements are installed automatically by pip or conda.
C compiler (required if installing from sources) cx_Logging >=3.0 (Windows only) importlib-metadata >= 4.8.3 (Python < 3.10) lief >= 0.11.5 (Windows only) setuptools patchelf >= 0.12 (Linux)
Note
Patchelf
patchelf is used in Linux and unix-like systems (FreeBSD, etc), except macOS. In Linux, cx_Freeze 6.10 installs it using new wheels available on PyPI.
If you have any trouble with it, use the old method:
To install patchelf in debian/ubuntu:
sudo apt-get install patchelf
To install patchelf in fedora:
dnf install patchelf
Or install patchelf from sources
Pipenv¶
Using pipenv, install or update by issuing one of the folowing commanda:
pipenv install cx_Freeze pipenv update cx_Freeze
Miniconda3 or Miniforge3¶
Directly from the conda-forge channel:
conda install -c conda-forge cx_freeze
If you are installing a pre-release or from sources, install the requirements using the same channel:
python c-compiler libpython-static (for python >=3.8 in linux and macOS) importlib-metadata py-lief (Windows) patchelf (Linux) declare SDKROOT or CONDA_BUILD_SYSROOT (for python 3.9+ in macOS)
An example using Miniconda3:
# If using python 3.9 or higer in Github Actions CI, macOS, use this: export SDKROOT=/Library/Developer/CommandLineTools/SDKs/MacOSX11.1.sdk # For macOS and Linux conda create -n cx39conda -c conda-forge python=3.9 libpython-static -y conda activate cx39conda conda install -c conda-forge c-compiler importlib-metadata patchelf -y pip install --no-binary :all: --pre cx_Freeze -v