search

frictionlessdata / datapackage-pipelines

Framework for processing data packages in pipelines of modular components.
https://frictionlessdata.io/
MIT License
118 stars 32 forks source link

Quickstart experience. User-friendly error handling #17

Open Vanuan opened 7 years ago

Vanuan commented 7 years ago

Here are some thoughts from newbie:

  1. I expected that dpp init would guide me through pipeline creation
  2. dpp --help didn't show how do I specify pipeline
  3. Running dpp serve and going to http://localhost:5000/ resulted in builtins.KeyError KeyError: b'all-pipelines' which is not a user-friendly way to show that I don't have any pipelines.

Suggestions:

  1. step-by-step pipeline creation (dpp init) wizard would be awesome
  2. Elaborate help by showing some examples e.g. dpp run ./pipeline.yaml, dpp serve ./pipeline.yaml
  3. dpp serve should validate whether there are any pipelines available and show nice user-friendly error with suggestions to fix
Vanuan commented 7 years ago

Well, dpp serve ./pipeline-spec.yaml didn't work either

Usage: dpp serve [OPTIONS]
Error: Got unexpected extra argument (./pipeline-spec.yaml)
Vanuan commented 7 years ago

I expected that dpp run would require yaml file, but it looks like yaml filename is hardcoded? Or maybe it just scans all the files? This is confusing.

If the default filename was dpp.yaml, it would make more sense. Additionally, I expected an option to override file name, e.g.:

dpp -f pipeline.yaml run albanian-treasury

The path symbol ./ is confusing too. Why do you need it? Does it scan all the folders looking for all the yaml files? In this case maybe I need to specify a folder with files?

danfowler commented 7 years ago

I have an issue where errors in the YAML file cause dpp to silently fail (that is, show no avail. pipelines)

akariv commented 7 years ago

Could you please provide an example of such a flawed YAML file (so I can add error messages in such cases)?

On Mon, 5 Jun 2017 at 12:24 Daniel Fowler notifications@github.com wrote:

I have an issue where errors in the YAML file cause dpp to silently fail (that is, show no avail. pipelines)

— You are receiving this because you were assigned.

Reply to this email directly, view it on GitHub https://github.com/frictionlessdata/datapackage-pipelines/issues/17#issuecomment-306143441, or mute the thread https://github.com/notifications/unsubscribe-auth/AAQMdfcShVs_pp1h3DefZ_QEFKUD48puks5sA8k0gaJpZM4LPGWf .

martinszy commented 6 years ago

This is an example of a broken yaml and the error it throws, it's not friendly at all in the sense that I cannot figure out what's wrong with it. https://gist.github.com/martinszy/6f4a0b2021687fa729ccf6a2044a9fc1

martinszy commented 6 years ago

I figured out that tabs don't work, and that spaces are very strinctly two