colbrydi / jupyterinstruct Goto Github PK

We need to go back in and fix the filename.

The hubgrader package has an import D2L from zip file that is way out of date and needs updating.

I think this may be easier for the student's to read. Here is where I started:

import calendar
from IPython.display import HTML
import bs4
cal = calendar.HTMLCalendar().formatmonth(2021, 1, withyear=True)
HTML(cal)

If the jupyter notebook generates an image, that image will not have alt text. Update validate to detect figures and return a warning instead:

ERROR: No Alt text in image - data:image/png;base64,iVBORw0KGgoAAAANSUhE..

makestudent.py is the old way of doing things. We need this to be depreciated. I added a few warnings but at some point the functions should be rolled into other files.

Currently the basename function in nbfilename returns with the extension. This should be updated to have an extension function separate from basename. This relates highly to what we will do for issue #5

The following warning in makestudent is wrong:

WARNING: file may be changing 0423-PROJECT_Final.ipynb != None

I think we just need to check the None object and change it to the filename.

When I test this on the MSU jupyterhub server I get an extra image with no alt text. Searching the html shows the image is a background image of some sort. I either need to remove the image, find a way to add an alt text or ignore the error inside of the validate function. TO help with search the beginning of the image start with the following:

data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAABCoAAAK6CAYAA

The ubgrader.importnb function needs to export the new student filename. This then needs to by copied to the publish folder and then converted. See instructor notebook for HW1 in mth314 as an example.

This bug is a little weird. In-line anchors do not render as html when exporting ipynb as web pages if there is an embeded form. The anchors work fine before the form but then after the form the html is replaced with text so the web anchors appear in the clear. Here is an example:

https://msu-cmse-courses.github.io/cmse401-S21-student/Class_Prep_Checklist

I assume it is something to do with how I am using nbconvert.

Many of my notebooks use the following syntax to denote emphasis:

<font color=red>**QUESTION:**</font>

This syntax works fine in jupyter notebook but dosn't translate well when exporting as html. I can fix this syntax using the following:

**<font color=red>QUESTION:</font>**

I need to write a converter function that will fix this for me and run it on the entire directory.

I also think there is a similar issue with emphasis vs emphasis but I need to do some testing to verify.

I also would like to do testing in jupyterlab where I think I noticed similar problems.

As written makestudnet will overwrite instructor files that do not following the INSTRUCTOR naming convention and do not specify an output directory. We should either issue a warning or pick a different file name (Maybe one with STUDENT).

In nbvalidate, I need to see if I can figure out how to change directories to the location where the ipynb files are located. Sometimes these files download other files and put them in the directory they are being run from.

I think with the upgrade from nbconvert 5.0 to nbconvert 6.0 something broke and I can no longer output properly formatted html. I would like to have it look like previous output with a framed boarder (ex: https://msu-cmse-courses.github.io/cmse802-f20-student/0000--Jupyter-Getting-Started-Guide.html) However the html that is being exported is the most basic and looks fairly flat (ex: https://msu-cmse-courses.github.io/mth314-s21-student/assignments/01-Python_Packages). I tried adding html_exporter.template_name = 'classic' but that didn't seem to do anything to change the format. I also tried changing classic to lab and a few others but still no change. I must be missing something.

Also, I think the command line is still working but I need to double check.

There is a bug when renaming files that adds an extra .ipynb extention to the student filename. This needs to be fix.

These include:

• Validator
• Migrate
• Instructor instructions
• Prep notebook

Jupyter notebooks work best with videos of size width=640,height=320. However, when exporting them to the website I prefer width="100%" and no height specification. This makes the videos fit nicely on desktops and phones.

I need to add a filter to change from width=640,height=320 to width="100%"

The function would generate the html version of the notebook and copy it and the ipynb to a destination folder. Something like the following:

InstructorNotebook.publish(studentfilename, pubfolder,preprocess=False,includeipynb=True)

There are different ways to download assignments in a zip file. The current code only allows for one kind of download. Maybe we can make it more robust to other downloads.

Embedded images (ones that start with data:image/png;base64 can fill up the output for the validate function. We should truncate the output for the first 20-50 characters.

Not sure if this is a good idea or not. But it may prove useful to extend nbfilename to extend pathlib.Path object. It could come in helpful for multi-platform compatibility (but I am not sure, may take a lot of extra, unneeded work).