-
Notifications
You must be signed in to change notification settings - Fork 160
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Add nbdiff-web-export to export a diff inside a rendered HTML
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
- Loading branch information
Showing
8 changed files
with
192 additions
and
29 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,102 @@ | ||
import sys | ||
import os | ||
import json | ||
|
||
from jinja2 import FileSystemLoader, Environment | ||
|
||
from ..args import ( | ||
Path, | ||
ConfigBackedParser, | ||
add_generic_args) | ||
|
||
from ..nbdiffapp import ( | ||
list_changed_file_pairs, | ||
resolve_diff_args, | ||
_build_diff) | ||
|
||
|
||
here = os.path.abspath(os.path.dirname(__file__)) | ||
static_path = os.path.join(here, 'static') | ||
template_path = os.path.join(here, 'templates') | ||
|
||
|
||
def build_arg_parser(): | ||
""" | ||
Creates an argument parser for the diff tool, that also lets the | ||
user specify a port and displays a help message. | ||
""" | ||
description = 'Difftool for Nbdime.' | ||
parser = ConfigBackedParser( | ||
description=description, | ||
add_help=True | ||
) | ||
add_generic_args(parser) | ||
parser.add_argument( | ||
"base", help="the base notebook filename OR base git-revision.", | ||
type=Path, | ||
nargs='?', default='HEAD', | ||
) | ||
parser.add_argument( | ||
"remote", help="the remote modified notebook filename OR remote git-revision.", | ||
type=Path, | ||
nargs='?', default=None, | ||
) | ||
parser.add_argument( | ||
"paths", help="filter diffs for git-revisions based on path", | ||
type=Path, | ||
nargs='*', default=None, | ||
) | ||
parser.add_argument( | ||
"--nbdime_url", | ||
type=Path, | ||
default="", | ||
help="URL to nbdime.js" | ||
) | ||
parser.add_argument( | ||
"--output-dir", | ||
type=Path, | ||
default="output/", | ||
help="a path to an output dir" | ||
) | ||
return parser | ||
|
||
|
||
def main_export(opts): | ||
env = Environment(loader=FileSystemLoader([template_path]), autoescape=False) | ||
outputdir = opts.output_dir | ||
nbdime_url = opts.nbdime_url | ||
if not nbdime_url: | ||
nbdime_url = "nbdime.js" | ||
import shutil | ||
shutil.copy(os.path.join(static_path, "nbdime.js"), os.path.join(outputdir, nbdime_url)) | ||
|
||
base, remote, paths = resolve_diff_args(opts) | ||
index = 1 | ||
for fbase, fremote in list_changed_file_pairs(base, remote, paths): | ||
# on_null="minimal" is crucial cause web renderer expects | ||
# base_notebook to be a valid notebook even if it is missing | ||
base_notebook, remote_notebook, diff = _build_diff(fbase, fremote, on_null="minimal") | ||
data = json.dumps(dict( | ||
base=base_notebook, | ||
diff=diff | ||
)) | ||
|
||
template = env.get_template("diffembedded.html") | ||
rendered = template.render( | ||
data=data, | ||
nbdime_url=nbdime_url) | ||
outputfilename = os.path.join(outputdir, "diff" + str(index) + ".html") | ||
with open(outputfilename, "w") as f: | ||
f.write(rendered) | ||
index += 1 | ||
|
||
|
||
def main(args=None): | ||
if args is None: | ||
args = sys.argv[1:] | ||
opts = build_arg_parser().parse_args(args) | ||
return main_export(opts) | ||
|
||
|
||
if __name__ == "__main__": | ||
sys.exit(main()) |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,38 @@ | ||
<!DOCTYPE html> | ||
<html> | ||
|
||
<head> | ||
<meta charset="utf-8"/> | ||
<meta name="viewport" content="width=device-width, initial-scale=1.0" /> | ||
|
||
<title>nbdime - diff and merge your Jupyter notebooks</title> | ||
|
||
</head> | ||
|
||
|
||
<!-- TODO: make nbdime.init() setup the forms/input user interface? --> | ||
|
||
<body> | ||
|
||
<div id="nbdime-header" class="nbdime-Diff"> | ||
<h3>Notebook Diff</h3> | ||
<script id='diff-and-base' type="application/json">{{ data|tojson|safe }}</script> | ||
<div id="nbdime-header-buttonrow"> | ||
<input id="nbdime-hide-unchanged" type="checkbox"><label for="cbox1">Hide unchanged cells</label></input> | ||
<button id="nbdime-trust" style="display: none">Trust outputs</button> | ||
<button id="nbdime-close" type="checkbox" style="display: none">Close tool</button> | ||
<button id="nbdime-export" type="checkbox" style="display: none">Export diff</button> | ||
</div> | ||
<div id=nbdime-header-banner> | ||
<span id="nbdime-header-base">Base</span> | ||
<span id="nbdime-header-remote">Remote</span> | ||
</div> | ||
</div> <!-- ndime-header --> | ||
|
||
<div id="nbdime-root" class="nbdime-root"> | ||
</div> | ||
|
||
<script src="{{ nbdime_url }}"></script> | ||
<noscript>Nbdime relies on javascript for diff/merge views!</noscript> | ||
</body> | ||
</html> |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters