You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
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
Possible Bug: The function get_tools_toc checks for an instance of CyberSfsCollection, but the correct class name might be CyberSfCollection as used in get_toc. This could lead to a runtime error if not addressed.
Code Quality: The generate_readme.py script lacks error handling, especially when reading or writing files, which might cause unhandled exceptions during execution.
Why: Correcting the class name from CyberSfsCollection to CyberSfCollection is crucial to avoid runtime errors and maintain consistency with the rest of the code.
10
Prevent AttributeError by safely checking for an attribute's existence
Check for the existence of PROJECT_URL using the getattr function to avoid potential AttributeError if the attribute is missing.
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.
User description
Description
This PR fixes #
Notes for Reviewers
Signed commits
PR Type
enhancement, documentation
Description
generate_readme.py
to automate the generation ofREADME.md
from a template.README_template.md
with placeholders for dynamic content, badges, installation instructions, and social media links.requirements.txt
to include new dependencies:boxes
,flask
, andlolcat
.Changes walkthrough 📝
generate_readme.py
Add script to generate README from template
generate_readme.py
descriptions.
all_tools
collection.README_template.md
Create README template with placeholders and guides
README_template.md
tools.
requirements.txt
Update dependencies for new features
requirements.txt
boxes
,flask
, andlolcat
.