Nuitka-winsvc User Manual

Nuitka-winsvc is a forked version of Nuitka, it supports compiling EXE as a Windows service.

Install

You can install Nuitka-winsvc by pip:

pip install nuitka-winsvc

Usage

In addition to supporting all the command line arguments of Nuitka, Nuitka-winsvc also provides 7 additional arguments for compiling the Windows services:

• --windows-service
  Enable Windows service mode, works only when compiling for Windows and onefile mode enabled.
• --windows-service-name
  Name of the Windows service. If not provided, the target program name will be used as the service name.
• --windows-service-display-name
  Display name of the Windows service. If not provided, the product name will be attempted to use.
• --windows-service-description
  Description of the Windows service. If not provided, the file description will be attempted to use.
• --windows-service-cmdline
  Additional command line arguments that will be passed to the service, such as --config config.json --output output.log .
• --windows-service-install
  Windows service installation command-line argument. Default value is install .
• --windows-service-uninstall
  Windows service uninstallation command-line argument. Default value is uninstall .

Use the following command to build a Windows service:

python -m nuitka --onefile --output-dir=build --windows-service --windows-service-name=myservice --windows-service-display-name="My Service" --windows-service-description="This is the description of my service" --windows-service-cmdline="-c config.yml -o output.log" --windows-service-install=install --windows-service-uninstall=uninstall main.py

When the python program is compiled successfully, you can use the following command to install the service:

.\main.exe install

Also you can use the following command to uninstall the service:

.\main.exe uninstall

Note: Administrator privileges is required when installing and uninstalling the Windows services. You should run the above commands as administrator.

The compiled EXE executable file can be run both as a Windows service and as a regular Windows program. However, it is important to note that the Windows service installation and uninstallation command-line arguments which specified by --windows-service-install and --windows-service-uninstall of Nuitka-winsvc compilation arguments will override the original behavior of the program. Therefore, the compiled Python program should avoid using the same command line arguments.