Configuration File

[StefanGreve]

Preamble

Currently, the CLI supports many different flags that in specific use-cases can be tedious to type all out. They also create a lot of noise in scripts where this application is used more than a couple of times. A configuration file would help anonfile to remember these settings. Hence, this feature only affects the CLI. For reasons of simplicity, use the built-in ConfigParser module to create a INI configuration file.

Requirements

1. The CLI should (by default) create a config file according to the rules of the get_config_dir function
2. Optionally, the user should be able to pass a custom config file through the command line via the --config paramater that ought to be attached to the parser object
3. If a custom config path is specified, the program should read its values from there, else take the default config file as additional input. This should only happen for values that are defined in both config files. This way, users can define settings in a global and local space that supplement each other.
4. If a parameter is set both in the config file and the command invocation, than the passed parameter should take precedence over any values that originated from a config file
5. If the default config file is removed or left in a broken state, continue with the execution flow but issue a warning in the console
6. The user should be able to customize the following values in the config file:

[Cli.Default]
DownloadDirectory = "$HOME\Downloads"
CheckForDuplicates = false
EnableLogging = false
LogLevel = 50

[Cli.Secrets]
Token = "REDACTED"
Proxy = "http://10.10.1.10:3128/"

Notes

1. DownloadDirectory shouldn't be initialized, this needs to be set by the end user
2. LogLevel values use the same values as here: https://docs.python.org/3/library/logging.html#logging-levels
3. LogLevel should keep the current default value (which currently corresponds to 20):

   anonfile-api/src/anonfile/anonfile.py

   Line 83 in 82412d5

   logger.setLevel(logging.INFO)

4. EnableLogging should be initialized with a value of false
5. Neither Token nor Proxy should be initialized by the default config file and need to be set manually
6. The proxy string format was explained in this commit message: 13b9f05
7. All high-level changes should be documented in the README.md file

Planning Status

Scheduled for milestone 1.1.0.

[StefanGreve]

It might be possible to test this feature with pytest, but I am not sure about that. I have some ideas, not sure what will come of it. Keeping the CLI code simple is also a concern, but I think that's still feasible with these requirements