Add viewer index.html to top level of results directory
#927
Conversation
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
tomvothecoder
changed the title
index.html to top level of results direcotry index.html to top level of results directory
tomvothecoder
commented
Jan 29, 2025
tomvothecoder
commented
Jan 29, 2025
There was a problem hiding this comment.
Hi @chengzhuzhang, another small PR ready for your review. Getting these out of the way quick!
PR description contains all the info.
|
@chengzhuzhang Nevermind not ready yet. The |
tomvothecoder
commented
Jan 30, 2025
There was a problem hiding this comment.
Ok @chengzhuzhang this PR is actually ready for review now. PR description for more info.
Comment on lines
+144
to
+159
| # Create an HTML file to list the contents of the prov dir. | ||
| index_html_path = os.path.join(results_dir, "index.html") | ||
|
|
||
| with open(index_html_path, "w") as f: | ||
| f.write("<html><body><h1>Provenance Files</h1><ul>") | ||
|
|
||
| for file_name in os.listdir(results_dir): | ||
| file_path = os.path.join(results_dir, file_name) | ||
| if os.path.isfile(file_path): | ||
| f.write( | ||
| f'<li><a href="{file_name}" target="_blank">{file_name}</a></li>' | ||
| ) | ||
|
|
||
| f.write("</ul></body></html>") | ||
|
|
||
| logger.info("Created provenance index HTML file at: {}".format(index_html_path)) |
Comment on lines
-391
to
-393
| path = os.path.join(parameters_results[0].results_dir, "viewer") | ||
| if not os.path.exists(path): | ||
| os.makedirs(path) |
There was a problem hiding this comment.
Moved logic to /viewer/main.py create_viewer()
| @@ -72,6 +74,7 @@ def insert_data_in_row(row_obj, name, url): | |||
| td = soup.new_tag("td") | |||
| a = soup.new_tag("a") | |||
| a["href"] = url | |||
| a["target"] = "_blank" # Open link in a new tab | |||
There was a problem hiding this comment.
Now open links in a new tab in main viewer index page.
Comment on lines
+160
to
+186
| def _create_root_index(root_dir: str, viewer_index_url: str): | ||
| """Create a root level `index.html` file that redirects to the viewer index. | ||
|
|
||
| Parameters | ||
| ---------- | ||
| root_dir : str | ||
| The root directory. | ||
| index_url : str | ||
| The url to the viewer index.html file. | ||
| """ | ||
| root_index_path = os.path.join(root_dir, "index.html") | ||
| relative_viewer_index_url = os.path.relpath(viewer_index_url, root_dir) | ||
| root_soup = BeautifulSoup( | ||
| f""" | ||
| <html> | ||
| <head> | ||
| <meta http-equiv='refresh' content='0; url={relative_viewer_index_url}' /> | ||
| </head> | ||
| <body></body> | ||
| </html> | ||
| """, | ||
| "lxml", | ||
| ) | ||
|
|
||
| # Write the root index file | ||
| with open(root_index_path, "wb") as f: | ||
| f.write(root_soup.prettify("utf-8")) |
There was a problem hiding this comment.
Creates a root level index.html that redirects to the /viewer/index.html.
chengzhuzhang
approved these changes
Jan 31, 2025
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description
This pull request updates the viewer to generate a top-level
index.htmlin the root directory (results_dir) that redirects to the/viewer/index.html. It fixes the/provindex page not displaying properly and makes links open in a new tab for convenience.Example: https://web.lcrc.anl.gov/public/e3sm/cdat-migration-fy24/562-index-html/
HTML Generation Improvements:
e3sm_diags_driver.py(closes [Bug]:/provdir does not display properly on browser #928)create_viewerfunction to create a root-levelindex.htmlthat redirects to the viewer index. [1] [2] (closes Add 'index.html' in top directory #562)Minor Fixes:
core_viewer.py.main.py.insert_data_in_rowfunction to open links in a new tab.Checklist
If applicable: