Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

scripts: high chance of problems on different OSs #203

Open
rkdarst opened this issue Oct 28, 2021 · 1 comment
Open

scripts: high chance of problems on different OSs #203

rkdarst opened this issue Oct 28, 2021 · 1 comment

Comments

@rkdarst
Copy link
Member

rkdarst commented Oct 28, 2021

This year we had various problems:

  • .py files couldn't be downloaded on windows
  • confusion on where to put files, either locally or remotely

I wonder if this is why last year used jupytext, it avoided downloading and uploading. I somehow recall that being more successful.

I think this lesson needs to be simpler and focused on one task (like last year): running your first script. As a backup plan, we should have the script where it can be copied-and-pasted into the Jupyter text file editor, without needing to download and re-upload. Argument parsing should be made simpler: not so complex that we think argument parsing is needed, but very simple, one or two arguments. Config files should be marked as optional (or I would even say moved to another lesson and briefly summarized as future directions) - leave time for the main thing without rush.

@tpfau
Copy link
Member

tpfau commented Nov 2, 2021

As for the first issue:
I think we could get around this by using a zip for the download, or by letting people c&p the original code, and I would prefer the latter option.
As for argument parsing:
Maybe split the current scripts lecture into ->
"Moving from Notebook to scripts -> Code reuse and command line access"
and
"Reuse whole scripts -> How to make flexible code"
With the former focusing on converting existing notebooks and moving common functionalities to their own files so that you can reuse them more easily in future projects and the latter focusing on argument parsing both command-line and option files to allow you to make your scripts flexible.

The only issue I have with this is that (imo) dependency/packaging/import should be discussed before creating your own import files.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants