Caution
This API is not finalised, and may change in a patch version.
installer.scripts
¶
Provides the ability to generate executable launcher scripts, that are based on
simple_launcher
. A description of how these scripts work is available in
simple_launcher’s README.
-
class
installer.scripts.
InvalidScript
¶ Raised if the user provides incorrect script section or kind.
-
class
installer.scripts.
Script
¶ Describes a script based on an entry point declaration.
-
__init__
(name, module, attr, section)¶ Construct a Script object.
-
generate
(executable, kind)¶ Generate a launcher for this script.
- Parameters
- Raises
InvalidScript – if no appropriate template is available.
- Returns
The name and contents of the launcher file.
- Return type
Tuple[Text, Binary]
-