Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

This code file: generate_readme.py needs some updation. #515

Open
vignesh1507 opened this issue Sep 28, 2024 · 0 comments
Open

This code file: generate_readme.py needs some updation. #515

vignesh1507 opened this issue Sep 28, 2024 · 0 comments

Comments

@vignesh1507
Copy link

Describe the bug

Potential Issues:

  1. Dependency on all_tools and HackingTool, HackingToolsCollection Classes:

The code relies on the all_tools list and classes like HackingTool and HackingToolsCollection. If these aren't correctly defined or imported, this will raise errors. Ensure that the core module and hackingtool are available and structured as expected.

  1. List Indexing all_tools[:-1]:

Both get_toc and get_tools_toc are called with all_tools[:-1]. This slices the list to exclude the last element. If there's a specific reason for excluding the last tool, it’s fine, but ensure that this is intentional. If not, you may want to include the full list by using all_tools.

  1. README_template.md File Not Found:

The code attempts to open a file named README_template.md. If this file doesn't exist in the directory where the script is run, a FileNotFoundError will be raised. Ensure that the template file is present.

  1. PROJECT_URL Might Be Empty:

In the get_tools_toc function, the code checks if tool.PROJECT_URL exists. If PROJECT_URL is empty (e.g., None or an empty string), it prints just the tool title without a link. This might be fine, but if the presence of PROJECT_URL is expected for all tools, you may want to handle missing URLs differently (e.g., logging a warning or error).

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant