archivesunleashed / auk-notebooks

Jupyter notebooks to assist in creating additional analysis and visualizations of Archives Unleashed Cloud derivatives.
https://cloud.archivesunleashed.org
Other
11 stars 5 forks source link

Add Python module. Issue #47 #49

Closed greebie closed 5 years ago

greebie commented 5 years ago

This PR replaces the function cell in the notebook with a python module and revises the function to work with the Notebook class.

A few notes:

greebie commented 5 years ago

Marked this draft for general comments first. Once the approach is okay, I'll mark it ready for review and we can work through some of the details.

greebie commented 5 years ago

I think the latest commit fixes the above review fixes. I also included mention that help(nb.function_name()) will provide instructions. Once I get word from @ianmilligan1 that the approach is okay, I will take this out of draft and work on fine tuning.

greebie commented 5 years ago

Thanks @ianmilligan1 @ruebot what are your thoughts on unit tests here? I can build them, but am not sure if they belong in the auk-notebooks folder.

ruebot commented 5 years ago

Out of scope for now. We'll cross that bridge when we publish it in it's own repo.

greebie commented 5 years ago

Latest commit should be ready to go. Moving this out of draft.