# Super ISO Updater
Super ISO Updater is a powerful tool that provides a convenient way to check for updates and install the latest versions of various ISO files. It is specifically designed to work with a Ventoy drive and supports a wide range of ISOs. This README will guide you on how to use this tool effectively.
## Table of Contents
- [Super ISO Updater](#super-iso-updater)
- [Table of Contents](#table-of-contents)
- [Getting Started](#getting-started)
- [Prerequisites](#prerequisites)
- [Installation](#installation)
- [Using pip](#using-pip)
- [Using git](#using-git)
- [Usage](#usage)
- [Running the script](#running-the-script)
- [Example on Windows](#example-on-windows)
- [Example on Linux](#example-on-linux)
- [Logging](#logging)
- [Customization](#customization)
- [Supported ISOs](#supported-isos)
- [Contribute](#contribute)
- [License](#license)
## Getting Started
### Prerequisites
- Python 3.10+ installed on your system.
### Installation
#### Using pip
1. Open your terminal or command prompt.
2. Install the package using the following command:
```sh
python -m pip install sisou
```
#### Using git
1. Clone this repository locally by running
```sh
git clone https://github.com/FolfyBlue/SuperISOUpdater
```
2. Navigate into the newly created directory by running
```sh
cd SuperISOUpdater
```
3. Install the module using the following command:
```sh
python -m pip install .
```
## Usage
To use sisou, follow these steps:
1. Open your terminal or command prompt.
2. Navigate to the directory where you cloned the script.
### Running the script
```sh
sisou <Ventoy Partition>
```
#### Example on Windows
```sh
sisou E:
```
#### Example on Linux
```sh
sisou /run/media/folfy/Ventoy/
```
### Logging
The script generates logs during its execution. You can control the log level using the `-l` or `--log-level` argument when running the script. The available log levels are: DEBUG, INFO, WARNING, ERROR, and CRITICAL. By default, the log level is set to INFO.
To set a specific log level, use the `-l` option followed by the desired log level:
```sh
sisou <Ventoy Partition> -l DEBUG
```
You can also specify a log file using the `-f` or `--log-file` argument to save the logs to a file instead of displaying them in the console:
```sh
sisou <Ventoy Partition> -f /path/to/log_file.log
```
## Customization
The `sisou.py` script uses a configuration file (`config.toml`) to define the ISOs to be updated. You can customize this configuration file to add or remove ISOs from the update process.
To customize the ISOs, open the `config.toml` file and edit the relevant sections. Each ISO is associated with an updater class (e.g., `Ubuntu`, `MemTest86Plus`, etc.). You can enable or disable ISOs by modifying the corresponding values in the configuration file.
_NOTE: Be cautious when modifying the configuration file, as incorrect changes may cause the script to malfunction._
You can specify a custom configuration file using the `-c` or `--config-file` argument when running the script:
```sh
sisou <Ventoy Partition> -c /path/to/config.toml
```
## Supported ISOs
The tool currently supports the following ISOs:
- **Diagnostic Tools**
- Hiren's BootCD PE
- Memtest86+
- SystemRescue
- UltimateBootCD
- Rescuezilla (editions: "focal", "jammy", "kinetic")
- **Boot Repair**
- Super Grub 2
- **Disk Utilities**
- Clonezilla
- GParted Live
- ShredOS
- HDAT2 (editions: "full", "lite", "diskette")
- **Operating Systems**
- **Linux**
- Arch Linux
- Debian (editions: "standard", "cinnamon", "kde", "gnome", "lxde", "lxqt", "mate", "xfce")
- Ubuntu (editions: "LTS", "interim")
- Fedora (editions: "KDE", "Budgie", "Cinnamon", "LXDE", "MATE_Compiz", "SoaS", "Sway", "Xfce", "i3")
- Linux Mint (editions: "cinnamon", "mate", "xfce")
- Manjaro (editions: "plasma", "xfce", "gnome", "budgie", "cinnamon", "i3", "mate")
- Kali Linux (editions: "installer", "live", "installer-netinst", "installer-purple")
- Rocky Linux (editions: "dvd", "boot", "minimal")
- OpenSUSE (editions: "leap", "leap-micro", "jump")
- TrueNAS (editions: "scale")
- Tails
- ChromeOS (editions: "ltc", "ltr", "stable")
- **Windows**
- Windows 11 (Multi-edition ISO, Any language)
- Windows 10 (Multi-edition ISO, Any language)
- **BSD**
- TrueNAS (editions: "core")
- **Other**
- FreeDOS (editions: "BonusCD", "FloppyEdition", "FullUSB", "LegacyCD", "LiteUSB", "LiveCD")
- TempleOS (editions: "Distro", "Lite")
## Contribute
If you have any suggestions, bug reports, or feature requests, feel free to open an issue or submit a pull request. Your contributions are highly appreciated!
## License
This project is licensed under the [GPLv3 License](./LICENSE).
---
Thank you for using Super ISO Updater! If you encounter any issues or need assistance, please don't hesitate to reach out. Happy updating!
Raw data
{
"_id": null,
"home_page": "https://github.com/JoshuaVandaele/SuperISOUpdater",
"name": "sisou",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.10, <4",
"maintainer_email": "",
"keywords": "ventoy,updater,os,iso,updater,sisou,cli",
"author": "Joshua Vandaele",
"author_email": "joshua@vandaele.software",
"download_url": "https://files.pythonhosted.org/packages/e2/5a/8a34a139e4d8dc2c0639f7a83b158ce85159b766c861499c70d00bed3391/sisou-1.1.2.tar.gz",
"platform": null,
"description": "# Super ISO Updater\n\nSuper ISO Updater is a powerful tool that provides a convenient way to check for updates and install the latest versions of various ISO files. It is specifically designed to work with a Ventoy drive and supports a wide range of ISOs. This README will guide you on how to use this tool effectively.\n\n## Table of Contents\n\n- [Super ISO Updater](#super-iso-updater)\n - [Table of Contents](#table-of-contents)\n - [Getting Started](#getting-started)\n - [Prerequisites](#prerequisites)\n - [Installation](#installation)\n - [Using pip](#using-pip)\n - [Using git](#using-git)\n - [Usage](#usage)\n - [Running the script](#running-the-script)\n - [Example on Windows](#example-on-windows)\n - [Example on Linux](#example-on-linux)\n - [Logging](#logging)\n - [Customization](#customization)\n - [Supported ISOs](#supported-isos)\n - [Contribute](#contribute)\n - [License](#license)\n\n## Getting Started\n\n### Prerequisites\n\n- Python 3.10+ installed on your system.\n\n### Installation\n\n#### Using pip\n\n1. Open your terminal or command prompt.\n2. Install the package using the following command:\n\n```sh\npython -m pip install sisou\n```\n\n#### Using git\n\n1. Clone this repository locally by running\n\n```sh\ngit clone https://github.com/FolfyBlue/SuperISOUpdater\n```\n\n2. Navigate into the newly created directory by running\n\n```sh\ncd SuperISOUpdater\n```\n\n3. Install the module using the following command:\n\n```sh\npython -m pip install .\n```\n\n## Usage\n\nTo use sisou, follow these steps:\n\n1. Open your terminal or command prompt.\n2. Navigate to the directory where you cloned the script.\n\n### Running the script\n\n```sh\nsisou <Ventoy Partition>\n```\n\n#### Example on Windows\n\n```sh\nsisou E:\n```\n\n#### Example on Linux\n\n```sh\nsisou /run/media/folfy/Ventoy/\n```\n\n### Logging\n\nThe script generates logs during its execution. You can control the log level using the `-l` or `--log-level` argument when running the script. The available log levels are: DEBUG, INFO, WARNING, ERROR, and CRITICAL. By default, the log level is set to INFO.\n\nTo set a specific log level, use the `-l` option followed by the desired log level:\n\n```sh\nsisou <Ventoy Partition> -l DEBUG\n```\n\nYou can also specify a log file using the `-f` or `--log-file` argument to save the logs to a file instead of displaying them in the console:\n\n```sh\nsisou <Ventoy Partition> -f /path/to/log_file.log\n```\n\n## Customization\n\nThe `sisou.py` script uses a configuration file (`config.toml`) to define the ISOs to be updated. You can customize this configuration file to add or remove ISOs from the update process.\n\nTo customize the ISOs, open the `config.toml` file and edit the relevant sections. Each ISO is associated with an updater class (e.g., `Ubuntu`, `MemTest86Plus`, etc.). You can enable or disable ISOs by modifying the corresponding values in the configuration file.\n\n_NOTE: Be cautious when modifying the configuration file, as incorrect changes may cause the script to malfunction._\n\nYou can specify a custom configuration file using the `-c` or `--config-file` argument when running the script:\n\n```sh\nsisou <Ventoy Partition> -c /path/to/config.toml\n```\n\n## Supported ISOs\n\nThe tool currently supports the following ISOs:\n\n- **Diagnostic Tools**\n - Hiren's BootCD PE\n - Memtest86+\n - SystemRescue\n - UltimateBootCD\n - Rescuezilla (editions: \"focal\", \"jammy\", \"kinetic\")\n- **Boot Repair**\n - Super Grub 2\n- **Disk Utilities**\n - Clonezilla\n - GParted Live\n - ShredOS\n - HDAT2 (editions: \"full\", \"lite\", \"diskette\")\n- **Operating Systems**\n - **Linux**\n - Arch Linux\n - Debian (editions: \"standard\", \"cinnamon\", \"kde\", \"gnome\", \"lxde\", \"lxqt\", \"mate\", \"xfce\")\n - Ubuntu (editions: \"LTS\", \"interim\")\n - Fedora (editions: \"KDE\", \"Budgie\", \"Cinnamon\", \"LXDE\", \"MATE_Compiz\", \"SoaS\", \"Sway\", \"Xfce\", \"i3\")\n - Linux Mint (editions: \"cinnamon\", \"mate\", \"xfce\")\n - Manjaro (editions: \"plasma\", \"xfce\", \"gnome\", \"budgie\", \"cinnamon\", \"i3\", \"mate\")\n - Kali Linux (editions: \"installer\", \"live\", \"installer-netinst\", \"installer-purple\")\n - Rocky Linux (editions: \"dvd\", \"boot\", \"minimal\")\n - OpenSUSE (editions: \"leap\", \"leap-micro\", \"jump\")\n - TrueNAS (editions: \"scale\")\n - Tails\n - ChromeOS (editions: \"ltc\", \"ltr\", \"stable\")\n - **Windows**\n - Windows 11 (Multi-edition ISO, Any language)\n - Windows 10 (Multi-edition ISO, Any language)\n - **BSD**\n - TrueNAS (editions: \"core\")\n - **Other**\n - FreeDOS (editions: \"BonusCD\", \"FloppyEdition\", \"FullUSB\", \"LegacyCD\", \"LiteUSB\", \"LiveCD\")\n - TempleOS (editions: \"Distro\", \"Lite\")\n\n## Contribute\n\nIf you have any suggestions, bug reports, or feature requests, feel free to open an issue or submit a pull request. Your contributions are highly appreciated!\n\n## License\n\nThis project is licensed under the [GPLv3 License](./LICENSE).\n\n---\n\nThank you for using Super ISO Updater! If you encounter any issues or need assistance, please don't hesitate to reach out. Happy updating!\n",
"bugtrack_url": null,
"license": "",
"summary": "A powerful tool to conveniently update all of your ISO files!",
"version": "1.1.2",
"project_urls": {
"Bug Reports": "https://github.com/JoshuaVandaele/SuperISOUpdater/issues",
"Homepage": "https://github.com/JoshuaVandaele/SuperISOUpdater",
"Source": "https://github.com/JoshuaVandaele/SuperISOUpdater/"
},
"split_keywords": [
"ventoy",
"updater",
"os",
"iso",
"updater",
"sisou",
"cli"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "44916c2e66ec87d21ebfa4c2e6eef2690d2904fb22bff5edf09ec1bea5e6a387",
"md5": "161a6cbb0f68251bdc1d7db1511e27e6",
"sha256": "e0b2307674b6546dd3e0626ba856293188fa080d40bb6baefa1ed6fb4959c77a"
},
"downloads": -1,
"filename": "sisou-1.1.2-py3-none-any.whl",
"has_sig": false,
"md5_digest": "161a6cbb0f68251bdc1d7db1511e27e6",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.10, <4",
"size": 65706,
"upload_time": "2024-02-05T13:27:08",
"upload_time_iso_8601": "2024-02-05T13:27:08.831260Z",
"url": "https://files.pythonhosted.org/packages/44/91/6c2e66ec87d21ebfa4c2e6eef2690d2904fb22bff5edf09ec1bea5e6a387/sisou-1.1.2-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "e25a8a34a139e4d8dc2c0639f7a83b158ce85159b766c861499c70d00bed3391",
"md5": "75740e44a317e185f478e2e919106dd3",
"sha256": "1f9d512e8baab131c03b160de0dbadeea632d29795bcb503c887c90ec7d4aa3d"
},
"downloads": -1,
"filename": "sisou-1.1.2.tar.gz",
"has_sig": false,
"md5_digest": "75740e44a317e185f478e2e919106dd3",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.10, <4",
"size": 41708,
"upload_time": "2024-02-05T13:27:09",
"upload_time_iso_8601": "2024-02-05T13:27:09.954359Z",
"url": "https://files.pythonhosted.org/packages/e2/5a/8a34a139e4d8dc2c0639f7a83b158ce85159b766c861499c70d00bed3391/sisou-1.1.2.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-02-05 13:27:09",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "JoshuaVandaele",
"github_project": "SuperISOUpdater",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"requirements": [],
"lcname": "sisou"
}
JSON
