Earth Lab logo should be pushed with .ipynb to assignment template repo

earthlab / autograding-notebooks

sample notebooks and notes for autograding project

MIT License

1 stars 1 forks source link

Earth Lab logo should be pushed with .ipynb to assignment template repo #22

Open jlpalomino opened 5 years ago

jlpalomino commented 5 years ago

There is a logo file (e.g. earth-lab-logo-rgb.png) in the release directory for an assignment, but it is currently not getting pushed to the assignment template repo during the execution of python make-template-repo.py both full-path-to-course-dir assignment1 --org_name earthlab-education. Only the .ipynb file is populating the empty template repo on GitHub for the assignment (e.g. https://github.com/earthlab-education/ea-bootcamp-00-test-assignment-template).

kcranston commented 5 years ago

What is the generic behaviour that we want? Options:

the script copies any .png files along with .ipynb files
script copies any image files (png, jpeg, jpg, etc)
new command line parameter to specify additional files

jlpalomino commented 5 years ago

I imagine that it would be nice to be able to specify other files, especially if we want students to add Markdown code to render those images, etc.

For now, the main reason is for the .png of the Earth Lab logo file.

So @lwasser can provide guidance on prioritizing the options.

lwasser commented 5 years ago

i would want any file in the directory to be moved. i am pretty sure that is how abc-classroom was setup. essentially i put any files into a directory that i wanted to use in my template repo. it would then push them over. we could have txt files, images, notebooks... heck rmd files in the future? who knows. i don't think we want to be specific about what files UNLESS this is setup in a way that there isn't a specific directory of files? Jenny will have to show me how this works. @jlpalomino can we run through the workflow together next week please? let's find a time - maybe monday?

lwasser commented 5 years ago

in the past the other thing i've added to template repos is .gitignore files. i can't see a good reason to limit file types added to a student repo... but if i'm missing something please say the word.

kcranston commented 5 years ago

The script does make a .gitignore - current .DS_Store and checkpoint files. I'll make the change to copy over everything else. Two questions:

Do you want to ignore hidden files?
Do you want to recursively copy directories and their contents?