Config File - Piblokto/FileSmasher.py GitHub Wiki

How to use the Config.ini file

The config.ini file was implemented along with Python 3's configparser library, in order to make this software as user-friendly as possible. Simply put, instead of having to modify the code, if a user would like to change variables, they can simply make the changes to the config.ini file, save it, then restart the script (if it's running).

Note: this is all subject to change in the future, with more versions and will be updated appropriately. When downloading a newer version please refer to the documentation again.


Variables

loop - loop is used to determine whether or not the main code will loop over the list of files.
Possible Inputs - 0, 1
0 determines that the loop function is off and will not activate.
1 determines that the loop function is on and will loop over lists.txt when it reaches the bottom.

open_documentation - open_documentation is used to determine whether or not the main code will open any relevant documentation in your browser when you are having issues with the program. Examples of this is when a lists.txt file can't be found, and the user has to create their own. In this case the documentation will open up to recommendations and formatting of how to create a lists.txt file.
Possible Inputs - 0, 1
0 determines that the documentation will not open.
1 determines that the documentation will open whenever it may be helpful.

Disclaimer: In future versions the possible inputs will likely change to True, and False, as well as the loop function fundamentally changing to refer the amount of times it will loop, as well as having pointers for no loop, and infinite loop.


Editing the Config File

The config.ini file can be opened using most text editors or IDE's. My recommendations for such are VIM, Nano, Emacs, and Notepad ++.

To edit the file, please refer to the above listed 'variables' for possible inputs. Simply just change what you want, save it, then run main.py.

In case you have any issues and break your config, feel free to download the default config.ini file from the repository.