feat: Make static_site_generator.py a standalone script #81
Conversation
This file contains hidden or 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
**Description**: Enables better testing at CLI Enables re-runs of html generation given a provided source json file like `output.projects.json` **Related Issue(s)**: closes #80 Signed-off-by: Roger Barker <roger.barker@swirldslabs.com>
Signed-off-by: Roger Barker <roger.barker@swirldslabs.com>
There was a problem hiding this comment.
Pull Request Overview
This pull request refactors static_site_generator.py to function as a standalone CLI script, enhancing its testing and rerun capabilities.
- Added CLI support with a main() function capturing JSON file input and handling file existence checks.
- Updated the generate_site() function with a return type annotation.
Comments suppressed due to low confidence (1)
src/static_site_generator.py:44
- [nitpick] Consider using the output_file parameter in the log message to ensure the log reflects the actual file path used when a different output file is provided.
logging.info("Static Site Generated @ ./_site/index.html")
Comment on lines
+47
to
+48
| ss_gen = StaticSiteGenerator() | ||
| data_file:str = input("Enter the path to the json file with data: ") |
There was a problem hiding this comment.
[nitpick] Consider using argparse for handling command line arguments to improve user experience and provide more flexibility than interactive input.
Suggested change
| ss_gen = StaticSiteGenerator() | |
| data_file:str = input("Enter the path to the json file with data: ") | |
| import argparse | |
| parser = argparse.ArgumentParser(description="Generate a static site from a JSON data file.") | |
| parser.add_argument("--data-file", required=True, help="Path to the JSON file with data.") | |
| args = parser.parse_args() | |
| ss_gen = StaticSiteGenerator() | |
| data_file = args.data_file |
Copilot uses AI. Check for mistakes.
Comment on lines
+54
to
+55
| with open(data_file, 'r') as f: | ||
| data = json.load(f) |
There was a problem hiding this comment.
[nitpick] It may be beneficial to wrap the JSON file loading in a try-except block to gracefully handle JSON decoding errors.
Suggested change
| with open(data_file, 'r') as f: | |
| data = json.load(f) | |
| try: | |
| with open(data_file, 'r') as f: | |
| data = json.load(f) | |
| except json.JSONDecodeError as e: | |
| print(f"[bold red]Error: Failed to decode JSON from file {data_file}. Please check the file format.[/bold red]") | |
| return |
Copilot uses AI. Check for mistakes.
andrewb1269hg
requested changes
May 2, 2025
Co-authored-by: Andrew Brandt <andrew.brandt@hashgraph.com> Signed-off-by: Roger Barker <roger.barker@swirldslabs.com>
andrewb1269hg
approved these changes
May 2, 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:
Enables better testing at CLI
Enables re-runs of html generation given a provided source json file like
output.projects.jsonRelated Issue(s):
closes #80