|
1 | 1 | # arGUIments
|
2 | 2 | Simplify execution of commands with arguments
|
| 3 | + |
| 4 | +## Purpose |
| 5 | + |
| 6 | + |
| 7 | + |
| 8 | +## Usage |
| 9 | +Launch with `python arGUIments.py` or `python arGUIments-console.py` (for the console version). |
| 10 | + |
| 11 | +You can also compile it to an exe by having the *.ico and *.spec file in same folder as arGUIments.py and launching the file "build-exe.bat". The output exe will be in the "dist" folder. |
| 12 | +Then you simply execute the exe file to launch it. |
| 13 | + |
| 14 | + |
| 15 | + |
| 16 | + |
| 17 | +## Config |
| 18 | +A settings.ini file will be generated to adjust some settings. |
| 19 | + |
| 20 | +``` |
| 21 | +[DEFAULT] |
| 22 | +software_path = yt-dlp |
| 23 | +output_folder = |
| 24 | +use_custom_output = False |
| 25 | +``` |
| 26 | + |
| 27 | +adjust "software_path" as per your install (this will be the default software for which you wish to create profiles). |
| 28 | + |
| 29 | +adjust "output_folder" will be the folder in which you wish the output of your commands to be. |
| 30 | + |
| 31 | +adjust "use_custom_output" to True if you wish to use the output_folder path (otherwise it will use the folder from which you call arGUIments.exe). |
| 32 | + |
| 33 | + |
| 34 | +## Profiles |
| 35 | +A profiles.json file will be generated once you create your first profile. |
| 36 | +You can also manually create it, or import one by copying the file in same folder as the software. |
| 37 | + |
| 38 | +``` |
| 39 | +{ |
| 40 | + "format": { |
| 41 | + "display_name": "Show video format", |
| 42 | + "shortname": "format", |
| 43 | + "command_template": "-F {0}", |
| 44 | + "custom_path": "", |
| 45 | + "arg_names": [ |
| 46 | + "Video link" |
| 47 | + ], |
| 48 | + "export_mode": "default", |
| 49 | + "custom_export_path": "", |
| 50 | + "custom_output_flag": "" |
| 51 | + } |
| 52 | +} |
| 53 | +``` |
| 54 | + |
| 55 | +shortname will be used to be passed as argument of arGUIments-console.exe (example : `arGUIments-console.exe format {insert_video_link}` to trigger the equivalent of running `yt-dlp -F {insert_video_link}`). |
| 56 | +As you start having more complex command lines, arGUIments can become more useful. |
| 57 | + |
| 58 | +command_template can accept multiple arguments (`{0}, {1}, etc`) as long as you have the same number of arg_names. |
| 59 | + |
| 60 | +custom_path is optional, in case you wish to have another software_path for this specific profile. |
| 61 | + |
| 62 | +export_mode will use the output_folder as per the settings, and will be setup to default to yt-dlp output command (`--output`). In case you wish to adjust yours for this profile, adjust the custom_export_path and custom_output_flag (mode will be `custom`). |
| 63 | + |
| 64 | +Note : you don't need to create your profiles.json manually, the GUI will do it for you. You can however adjust it manually (or programmatically) if you wish. |
0 commit comments