Add More CLI Options

[bbenefield89]

Expected Behavior

• --alarms Lists all pre-set alarms
• --help Basic help command like any normal CLI tool
• help [option] Displays information about a specific [option]
• --new-preset User can create a new pre-set alarm

Actual Behavior

Steps to Reproduce (if any)

Proposed Solution (if any)

Add relevant commands to ./src/cli_options.json

Comments

Any new top-level command added will need to have a relevant command in the help object as well or that PR will not be merged until completed.

For example, the command --alarm also has a help --alarm command that explains how to use the command and a short description of the --alarm command.

[illright]

Can I rewrite the CLI argument parsing with the built-in argparse library? Thus removing the need for a separate JSON file

[itsx]

Another option, besides argparse would be using click library:
https://click.palletsprojects.com/en/5.x/

[bbenefield89]

@illright Sorry for the late response.

I say go for it. If your contributions can make writing command-line arguments easier then I am all for it.

[illright]

@bbenefield89 Do you want me to actually implement the behaviour of storing the times somewhere and calling the script with cron jobs and stuff or simply the CLI options with placeholder functions? Because in the former case I don't actually know how are you planning to do it, what is a pre-set alarm, etc.

[bbenefield89]

@illright So a pre-set alarm would be similar to how your alarm system on your mobile phone works. You're able to set an alarm, without triggering its function, view it from your phone and then activate it whenever you want.

So the --alarms command would print out a list of pre-set alarms that are readily available to the user.

The --new-preset command would ask the user for a certain time or an amount of time, in minutes, they want to set the alarm and then ask them to give this alarm a name which could be used later to start this alarm. For example, if I wanted an alarm to go off after 20minutes I would make a new alarm, name it 20min and later call it with something like pylarm 20min. This is just an idea and not set in stone though.

Just to clarify, no need for cron jobs. I think a JSON file generated by Pylarm that holds these alarms names and times would be a decent solution. Ideas?

Edit

Let me also add that there's no need for you to complete this entire section! A lot goes into handling these actions so do what you can/want to.