🐛Bug Fix: Project structure text file #808
Merged
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.
Pull Request for PyVerse 💡
Requesting to submit a pull request to the PyVerse repository.
Issue Title
Please enter the title of the issue related to your pull request.
#805
Info about the Related Issue
What's the goal of the project?
PyVerse is an open-source collection of diverse Python projects, tools, and scripts, ranging from beginner to advanced, across various domains like machine learning, web development, and automation.
Name
Please mention your name.
Yash K. Saini
GitHub ID
Please mention your GitHub ID.
yashksaini-coder
Email ID
Please mention your email ID for further communication.
Mail
Identify Yourself
Mention in which program you are contributing (e.g., WoB, GSSOC, SSOC, SWOC).
GSSoC
Closes
Enter the issue number that will be closed through this PR.
*Closes: #805 *
Describe the Add-ons or Changes You've Made
Give a clear description of what you have added or modified.
This pull request includes significant updates to the directory structure script and its associated GitHub workflow. The changes simplify the script, improve its functionality, and streamline the workflow for updating the project structure.
Updates to the Directory Structure Script:
.github/scripts/update_dir_structure.py
: Replaced the old script with a new version that generates a Markdown-formatted directory structure for Python and Jupyter files, excluding certain directories likescripts
andvenv
. The new script usesargparse
for argument parsing and includes detailed docstrings for better readability.Updates to the GitHub Workflow:
.github/workflows/update-structure.yml
: Modified the workflow to run on every push instead of a scheduled cron job. Simplified the job steps by removing unnecessary setup and updating the script execution to generateProject-Structure.md
directly.Type of Change
Select the type of change:
How Has This Been Tested?
Describe how your changes have been tested.
Describe your testing process here.
Pyverse-805.webm
Checklist
Please confirm the following: