ml6team / fondant / 6435730120

91%

push

github

Restructure-cli (#488)

With the introduction of a new compiler and runner for vertex, I feel
the need to restructure the CLI a bit. This is a draft PR (docs and
tests still need to be updated).

**Running**

* Before

```bash
fondant run pipeline.py --local
```

* After

Mode is not longer a positional argument, Pipeline/reference is moved to
the end (similar to docker).

```bash
 fondant run local pipeline.py 
```
**Help**

* Before 

Arguments are not isolated per mode which makes it which argument
belongs to which mode (e.g. extra volumes not needed for KFP)
```
❯ fondant run -h                 
usage: fondant run [-h] (--local | --kubeflow) [--output-path OUTPUT_PATH] [--extra-volumes EXTRA_VOLUMES [EXTRA_VOLUMES ...]] [--build-arg BUILD_ARG] [--host HOST] ref

positional arguments:
  ref                   Reference to the pipeline to run, can be a path to a spec file or a module containing the pipeline instance that will be compiled first (e.g. pipeline.py)

options:
  -h, --help            show this help message and exit
  --local
  --kubeflow
  --output-path OUTPUT_PATH, -o OUTPUT_PATH
                        Output directory
  --extra-volumes EXTRA_VOLUMES [EXTRA_VOLUMES ...]
                        Extra volumes to mount in containers
  --build-arg BUILD_ARG
                        Build arguments to pass to `docker build`. Format {key}={value}.
  --host HOST           KubeFlow pipeline host url
```
* After

```bash
❯fondant run -h  

positional arguments:
  {local,kubeflow}
    local           Local runner
    kubeflow        Kubeflow runner
  ref               Reference to the pipeline to run, can be a path to a spec file or a module containing the pipeline instance that will be compiled first (e.g. pipeline.py)

options:
  -h, --help        show this help message and exit
```

To further deep dive 

```bash
❯ fondant run local -h                  
usage: fondant run local [-h... (continued)

50 of 50 new or added lines in 1 file covered. (100.0%)

1176 of 1268 relevant lines covered (92.74%)

3.7 hits per line