meltano / meltano-codespace-ready

Have your first meltano project running within 5 minutes - no setup - no install - no boundaries. All inside GitHub Codespaces. (GitHub account required)
https://meltano.com/
MIT License
24 stars 10 forks source link

Replace `meltano_tut` with native invocations #3

Open aaronsteers opened 1 year ago

aaronsteers commented 1 year ago

Since we're asking the user to copy-paste one or two commands anyway, I think it would be easier to understand if we try to replace meltano_tut references with their native invocations.

meltano_tut init

echo "=== Running wrapped 'meltano init' ==="
rm meltano.yml
meltano init new_project
rm new_project/README.md
mv new_project/* .
rm new_project
mkdir data
cp codespaces_tutorial/customers.csv data/customers.csv
echo "=== Now head to the README.md and continue with step 2!"
  1. I think we can safely assume a new project - and the 'reset' functions can be moved to something like a dedicated tutorial_reset.sh.
  2. We don't need to move the csv, do we? We could start with it already in data or tutorial_data and just access it from there during the EL step.
  3. Then, the replacement could just be meltano init ..
  4. Note: the above requires: https://github.com/meltano/meltano/pull/6954
sbalnojan commented 1 year ago

Just to reaffirm why 4. is necessary: because the VS Code extension otherwise won't work (right now) :-) (And I do want to change the default environment to codespaces, so we do kind of need a meltano.yml in place)

So I do think that's fine, although I also was thinking about a "tutorial" command. Some CLIs have that and it's kind of nice. I think and enables an even better workflow control.

aaronsteers commented 1 year ago

I also was thinking about a "tutorial" command.

Interesting idea! Do you mind logging an issue or discussion for meltano tutorial as a top level command?