Skip to content

ventoyLIB

Marcel-Brian Wilkowsky edited this page Nov 20, 2021 · 9 revisions

Import library

import ventoyl

Create an object

ventoy_dev = ventoyl.ventoyl()

Call a method

iso_files = ventoy_dev.getISOFiles()
for file in iso_files:
    print(file)

Constructor

The constructor accepts following parameter:

ventoy_dev = ventoyl.ventoyl([String ventoy_device, Boolean debug])
# ventoy_device: If ventoy_device is type None, the constructor runs the method findVentoyDevice()
# debug: Enable debug mode to retrieve more information in output

Available methods

Method Purpose
__init__(ventoy_device=None, debug=False) Search for a Ventoy device and mounts it, if ventoy_device is not set.
findVentoyDevice() Searching for a Ventoy device on the system. Returns False if nothings found, otherwise True. This method also sets the object variable device (full path of the device) and devicefs (the filesystem)
checkVentoyMount() This method checks whether the filesystem is already mounted or not. Returns True/False.
mountVentoyDevice() Mounts the specified/found Ventoy device
umountVentoyDevice() Umount the Ventoy device, if mounted
isVentoyMounted() Returns True if the Ventoy device is mounted, False otherwise
getVentoyMountDir() Returns a String of the current mount point, if Ventoy device is mounted
getISOFiles() returns a list of found iso images on the device. If no ISO images can be found, this functions return an empty list
getVentoyConfig() returns a JSON load of the current Ventoy plugin configuration
getVentoylLogFile() Returns the path of the Ventoyl log file
deleteISO(String isofile_path) Deletes the specified iso file. Returns True if the file successfully deleted, otherwise False
installLatestVentoy(Bool gui, Bool force) This method downloads the latest released Ventoy tarball, extracts it in a temporary directory and starts the shell installer, if gui is False. If you want to reinstall Ventoy, set force to True.
Clone this wiki locally