Rework command line interface

[amotl]

Hi there,

Benjamin is currently working on reworking the command line interface. While he looked at Typer first, he will now settle with click.

This is the right place to discuss the new command line interface for Wetterdienst.

With kind regards,
Andreas.

cc @gutzbenj, @wetterfrosch

[amotl]

The current interface, for example, looks like this

wetterdienst dwd observation stations --parameter=kl --resolution=daily --period=recent
wetterdienst dwd observation values --station=1048,4411 --parameter=kl --resolution=daily --period=recent

wetterdienst dwd forecast stations
wetterdienst dwd forecast values --parameter=ttt,ff --station=65510

When modernizing the underpinnings of the implementation, we might also think about the general design and wording of the items used in the CLI.

[amotl]

What is obvious is that we will get a new parameter --provider=, right?

[gutzbenj]

--provider and --kind according to the different types of data - observation and forecast - we expect from providers

[amotl]

Hi Benjamin,

Preview

So, the new interface will look roughly like this?

DWD

# Observations
wetterdienst stations --provider=dwd --kind=observation --resolution=daily --period=recent --parameter=kl
wetterdienst values --provider=dwd --kind=observation --resolution=daily --period=recent --station=1048,4411 --parameter=kl 

# MOSMIX forecast
wetterdienst stations --provider=dwd --kind=forecast
wetterdienst values --provider=dwd --kind=forecast --station=65510 --parameter=ttt,ff

# Radar
wetterdienst stations --provider=dwd --kind=radar
wetterdienst values --provider=dwd --kind=radar --station=foo,bar --parameter=baz

ECCC

# Observations
wetterdienst stations --provider=eccc --kind=observation --resolution=daily --period=recent --parameter=baz
wetterdienst values --provider=eccc --kind=observation --resolution=daily --period=recent --station=foo,bar  --parameter=baz

I like it!

Details

Will we keep the positional argument style for designating the first level subcommand like outlined above? That the parameters --provider and --kind are needed right now is completely clear, however I would like to also keep the subcommand style because I like it in general and found many modern CLI interfaces designed like this. So, my proposal for the toplevel subcommands would be:

wetterdienst stations
wetterdienst values
wetterdienst about
wetterdienst restapi
wetterdienst explorer
wetterdienst --version
wetterdienst --help

It would be nice if we could attach more specific help texts to those toplevel subcommands. So that, for example, wetterdienst stations --help would only show a more descriptive help section specific to this subcommand.

What do you think?

With kind regards,
Andreas.

[gutzbenj]

What you are explaining is exactly what click offers us so, yep, that's what its going to look like.

[amotl]

Last year

While looking at Typer first, we will now settle with click.

This year

Cyclopts is what you thought Typer was.

-- https://github.com/BrianPugh/cyclopts#compared-to-typer