What Are Modules?¶
Modules are a simple way of telling gambas precise information about a specific application or piece of software. The type of information they provide can be divided into 3 parts.
The Basics¶
This section groups the basic information a module can provide.
- Name
- This will be the name Mundus will use to refer to this application.
- Category
- A short name so that the user can skip the description and still know what the application does
- Description
- A short paragraph describing the application, and it’s uses.
- Executable
- This is the name of the executable file inside one of the folders specified with the $PATH env var.
- Website
- Used by Mundus to provide an easy way of accessing an application’s website.
- Warning
- A general warning shown when displaying other information about an application.
- Submodules
- Here, every submodule the module packages is described along with its Path, Description and Warning
- Directories
- Returns an array of every directory it contains in its submodules for easy parsing.
Local State¶
This properties are used to track the state of the application on the user’s PC.
- isInstalled
- This is used to detect whether or not the executable was found.
- HasConfig
- This variable will evaluate to True if any of the submodules is found (i.e. any of the directories listed as submodule exist)
- Version
- Used to store the version of the local module. It is later compared with the version for the same module in the Module Index