The construct.yaml file is the primary mechanism for controlling
the output of the Constructor package. The file contains a list of
key/value pairs in the standard YAML format.
Each configuration option is listed in its own subsection below.
Constructor employs the Selector enhancement of the YAML format
first employed in the
conda-build
project. Selectors are specially formatted YAML comments that Constructor
uses to customize the specification for different platforms. The precise
syntax for selectors is described in
this section
of the conda-build documentation. The list of selectors available
for use in Constructor specs is given in the section
Available selectors below.
required: yes
type: string
Name of the installer. Names may be composed of letters, numbers,
underscores, dashes, and periods, but may not begin or end with a
dash or period.
required: yes
type: string
Version of the installer. Versions may be composed of letters, numbers,
underscores, dashes, and periods, but may not begin or end with a
dash or period.
required: no
type: list
The conda channels from which packages are retrieved. At least one channel must
be supplied, either in channels or channels_remap.
required: no
type: list
A list of src/dest channel pairs. When retrieving the packages, conda will
use the src channels; but rename those channels to dst within the installer.
This allows an installer to be built against a different set of channels than
will be present when the installer is actually used. Example use:
channels_remap:
-
src: file:///tmp/a3/conda-bld
dest: https://repo.anaconda.com/pkgs/main
-
src: file:///tmp/r/conda-bld
dest: https://repo.anaconda.com/pkgs/r
At least one channel must be supplied, either in channels or channels_remap.
required: no
types: list, string
A list of package specifications; e.g. python 2.7*, pyzmq or numpy >=1.8.
The specifications are identical in form and purpose to those that would be
included in a conda create --file command. Packages may also be specified
by an exact URL; e.g.,
https://repo.anaconda.com/pkgs/main/osx-64/openssl-1.0.2o-h26aff7b_0.tar.bz2.
required: no
types: list, string
A list of package specifications to be recorded as "user-requested" for the
initial environment in conda's history file. This information is used by newer
versions of conda to better filter its package choices on subsequent installs;
for example, if python=3.6 is included, then conda will always seek versions
of packages compatible with Python 3.6. If this is option is not provided, it
will be set equal to the value of specs.
required: no
type: list
A list of package names to be excluded after the specs have been resolved.
For example, you can say that readline should be excluded, even though it
is contained as a result of resolving the specs for python 2.7.
required: no
type: list
A list of packages with menu items to be instsalled. The packages must have
necessary metadata in "Menu/.json"). Menu items are currently
only supported on Windows. By default, all menu items will be installed;
supplying this list allows a subset to be selected instead.
required: no
type: boolean
By default, constructor will warn you when adding packages with duplicate
files in them. Setting this option to false will raise an error instead.
required: no
types: boolean, string
Obsolete. The current version of constructor relies on the standalone
conda executable for its installation behavior. This option is now
ignored with a warning.
required: no
type: string
Name of the environment to construct from. If this option is present, the
specs argument will be ignored. Using this option allows the user to
curate the enviromment interactively using standard conda commands, and
run constructor with full confidence that the exact environment will be
reproduced.
required: no
type: string
Path to an environment file to construct from. If this option is present, the
specs argument will be ignored. Instead, constructor will call conda to
create a temporary environment, constructor will build and installer from
that, and the temporary environment will be removed. This ensures that
constructor is using the precise local conda configuration to discover
and install the packages.
required: no
type: string
File type extension for the files to be transmuted into. Currently supports
only '.conda'. See conda-package-handling for supported extension names.
If left empty, no transumating is done.
required: no
type: list
If this value is provided as well as write_condarc, then the channels
in this list will be included as the value of the default_channels:
option in the environment's .condarc file. This will have an impact
only if conda is included in the environmnent.
required: no
type: string
The channel alias that would be assumed for the created installer
(only useful if it includes conda).
required: no
type: string
The filename of the installer being created. If not supplied, a reasonable
default will determined by the name, version, platform, and installer type.
required: no
types: string, list
The type of the installer being created. Possible values are:
sh: shell-based installer for Linux or macOS;pkg: macOS GUI installerexe: Windows GUI installer
The default type is sh on Linux and macOS, and exe on Windows. A special
value of all builds both sh and pkg installers on macOS, as well
as sh on Linux and exe on Windows.
required: no
type: string
Path to the license file being displayed by the installer during the install
process.
required: no
type: boolean
If False (default), the package cache in the pkgs subdirectory is removed
when the installation process is complete. If True, this subdirectory and
its contents are preserved. If keep_pkgs is False, Unix .sh and Windows .msi
installers offer a command-line option (-k and /KeepPkgCache, respectively)
to preserve the package cache.
required: no
type: boolean
Only affects .sh installers. If False (default), the installer launches
an interactive wizard guiding the user through the available options. If
True, the installer runs automatically as if -b was passed.
required: no
type: string
By default, the MacOS pkg installer isn't signed. If an identity name is specified
using this option, it will be used to sign the installer. Note that you will need
to have a certificate and corresponding private key together called an 'identity'
in one of your accessible keychains.
required: no
types: boolean, string
Obsolete. The current version of constructor relies on the standalone
conda executable for its installation behavior. This option is now
ignored with a warning.
required: no
type: boolean
By default, no .condarc file is written. If set, a .condarc file is written to
the base environment if there are any channels or conda_default_channels is set.
required: no
types: dictionary, string
If set, a .condarc file is written to the base environment containing the contents
of this value. The value can either be a string (likely a multi-line string) or
a dictionary, which will be converted to a YAML string for writing. Note: if this
option is used, then all other options related to the construction of a .condarc
file—write_condarc, conda_default_channels, etc.—are ignored.
required: no
type: string
Name of the company/entity who is responsible for the installer.
required: no
type: string
Application name in the Windows "Programs and Features" control panel.
Defaults to ${NAME} ${VERSION} (Python ${PYVERSION} ${ARCH}).
required: no
type: string
Path to a pre-install script. For Unix .sh installers, the shebang
line is respected if present; otherwise, the script is run by the POSIX
shell sh. Note that the use of a shebang can reduce the portability of
the installer. This option is not supported for Windows .exe or macOS
.pkg installers.
required: no
type: string
Path to a post-install script. For Unix .sh installers, the shebang
line is respected if present; otherwise, the script is run by the POSIX
shell sh. Note that the use of a shebang can reduce the portability of
the installer. For Windows .exe installers, this must be a .bat file.
This option is not supported for macOS .pkg installers.
required: no
type: string
A description of the purpose of the supplied post_install script. If this
string is supplied and non-empty, then the Windows and macOS GUI installers
will display it along with checkbox to enable or disable the execution of the
script. If this string is not supplied, it is assumed that the script
is compulsory and the option to disable it will not be offered.
required: no
type: string
Path to a pre uninstall script. This is only supported for on Windows,
and must be a .bat file.
required: no
type: string
Set default install prefix. On Linux, if not provided, the default prefix is
${HOME}/${NAME}. On windows, this is used only for "Just Me" installation;
for "All Users" installation, use the default_prefix_all_users key.
If not provided, the default prefix is ${USERPROFILE}\${NAME}.
required: no
type: string
Set default installation prefix for domain user. If not provided, the
installation prefix for domain user will be ${LOCALAPPDATA}\${NAME}.
By default, it is different from the default_prefix value to avoid installing
the distribution in the roaming profile. Windows only.
required: no
type: string
Set default installation prefix for All Users installation. If not provided,
the installation prefix for all users installation will be
${ALLUSERSPROFILE}\${NAME}. Windows only.
required: no
type: string
Path to an image in any common image format (.png, .jpg, .tif, etc.)
to be used as the welcome image for the Windows installer.
The image is re-sized to 164 x 314 pixels.
By default, an image is automatically generated.
required: no
type: string
Like welcome_image for Windows, re-sized to 150 x 57 pixels.
required: no
type: string
Like welcome_image for Windows, re-sized to 256 x 256 pixels.
required: no
type: string
The color of the default images (when not providing explicit image files)
used on Windows. Possible values are red, green, blue, yellow.
The default is blue.
required: no
type: string
If welcome_image is not provided, use this text when generating the image
(Windows only). Defaults to name.
required: no
type: string
If header_image is not provided, use this text when generating the image
(Windows only). Defaults to name.
required: no
type: boolean
Whether to add the installation to the PATH environment variable. The default
is true for GUI installers (msi, pkg) and False for shell installers. The user
is able to change the default during interactive installation.
required: no
type: boolean
Default choice for whether to register the installed Python instance as the
system's default Python. The user is still able to change this during
interactive installation. (Windows only)
required: no
type: boolean
Check the length of the path where the distribution is installed to ensure nodejs
can be installed. Raise a message to request shorter path (less than 46 character)
or enable long path on windows > 10 (require admin right). Default is True. (Windows only)
required: no
type: boolean
Check if the path where the distribution is installed contains spaces and show a warning
if any spaces are found. Default is True. (Windows only)
required: no
type: string
If nsis_template is not provided, constructor uses its default
NSIS template. For more complete customization for the installation experience,
provide an NSIS template file. (Windows only)
aarch64arm64armv7llinuxlinux32linux64osxppc64les390xunixwinwin32win64x86x86_64