Add nbdiff-web-export to export HTML diff using just command line #552
Conversation
nbdiff-web-export --ouput-dir output ./nbdime/webapp/testnotebooks/remote.ipynb ./nbdime/webapp/testnotebooks/base.ipynb or nbdiff-web-export --output-dir output HEAD~1 HEAD These would generate inside output directory diff1.html diff2.html .... diffN.html depending how many files has been changed it would also drop nbdime.js in the output directory Alternatively one can use --nbdime_url optional parameter to specify where to get nbdime.js
|
I figured out how to combine two commands i.e. do the diff and then generate html to render it so I will update this pull request |
trams
force-pushed
the
export_to_html
branch
from
df81002
to
a1f12b6
Compare
nbdime/tests/test_cli_apps.py
Outdated
| @@ -286,6 +286,16 @@ def test_nbdiff_app_no_colors(filespath, capsys): | |||
| assert 0 == main_diff(args) | |||
|
|
|||
|
|
|||
| def test_nbdiff_app_fail_if_file_is_missing(filespath): | |||
| # Simply check that the --color-words argument is accepted, not behavior | |||
There was a problem hiding this comment.
Good catch. I just copy pasted the test with a comment
|
So things which are not working
But I do believe it is already usable. I will definitely try to integrate this tool into our ML CI/CD so I will get a better sense how to make it more user friendly |
|
@vidartf I addressed your concerns. Let me know if there is anything else preventing this from merging? Thank you |
|
Oh, I thought your previous comment meant you wanted to go away and try it out some more before coming back and making adjustments. I'll try to have a look this week 👍 |
Important points: - Allow for configuration of mathjax and hide unchanged defaults - Fix read/write encodings so it works on Windows - Add some error handling code if we end up with broken json for the diff view Remaining TODO: - Ensure we build and use a single bundle. Existing nbdime.js does not bundle all the things (fonts, and some chunked JS). - Find and check a decent default for MathJax: Use CDN as default, or switch to using jupyter-renderer's mathjax3 bundled ?
|
Hi again, I did some cleanup to align it more with some internal conventions, fixing some issues while doing that. There are a few remaining issues:
|
|
Oh, and we will at some points need to add test coverage for the new CLI entry point. |
|
An option to solve the MathJax for #551 is outline here: #551 (comment), but that won't solve the issue for the embedded case, so we will probably need to use a separate JS entrypoint / bundle that includes the MathJax code (making the embed option even heavier). That should still probably be ok for now, and then we can look at trimming that bundle later on. |
|
Thank you for all the great feedback. I still did not have a chance to fully go though comments and I do not fully understand all the comments yet. Meanwhile I had some success integrating this version in our CI/CD and it seems it works fine but to be fair in the last few weeks we did not have a lot of changes to our notebooks so we probably did not hit any edge cases As for whether to extend the current bundle or to create a separate I do not have specific opinion. |
|
hello, when the code can be merged? I really need this feature！！ |
|
@trams Thanks so much for starting the work on this. This is exactly what we need as well. Are there any updates on getting this merged? |
|
@wenindoubt I did not have a chance to address the maintainer's comments mostly due to lack of expertise (I am a backend developer) and lack of time. I am open on accepting anyone's help! I am open on allocating some time on zoom calls for XP sessions or consultations if needed |
This is Proof-of-concept but it should be good enough to actually try to use it
How to try it?
nbdiff ./nbdime/webapp/testnotebooks/remote.ipynb ./nbdime/webapp/testnotebooks/base.ipynb --out diff_with_base.json --include-base
nbdiff-web-export diff_with_base.json ./nbdime/webapp/static/nbdime.js > ./diff.html
What has been tested?
Only the commands above
I am thinking about actually combining two command and teaching nbdiff-web-export to build diff and then html. I do not see the reason why I won't be able to import appropriate packages and call some kind of diff method. What do you think about this?
I have no idea how this would work with several changed notebooks in some git commit. I honestly did not try it. If someone can try it I would appreciate
As you can see in code change I am trying to reuse as much as possible existing components: nbdime.js to render the diff. I copy pasted and modified a template (would be nice to just reuse it but yet to figure this out). Added python code is mostly trivial
What is missing?
I would really appreciate your feedback