Feat: Automated project structure updation using github workflows, python scripts and action bot

[J-B-Mugundh]

Describe the feature

Currently, we dont have the automated project structure updation in our repository. It'll be benefitial for the new commers to understand the project structure from readme itself and reduces the manual work as well.

Proposed Solution

Automated project structure updation using github workflows, python scripts and action bot

Explanation

The project structure automation process enhances repository organization and accessibility for contributors by leveraging GitHub Actions and a Python script.

Script Development: A Python script is created to traverse the repository’s file system, generating a visual representation of the project structure. This script outputs the structure to a file (e.g., repo_structure.txt).

GitHub Workflow Setup: A GitHub Actions workflow is configured to automate the script execution based on specified triggers, such as scheduled intervals or repository changes.

Execution Flow:

The workflow checks out the repository. It sets up the Python environment and installs any necessary dependencies. The script runs, updating the project structure file as needed. If changes are detected, the workflow commits and pushes these updates back to the repository.

Documentation Update: The workflow the updates the project structure in readme or in a different file.

Add ScreenShots

Record

• [X] I agree to follow this project's Code of Conduct
• [X] I'm a GSSOC'24 contributor
• [X] I want to work on this issue

[github-actions[bot]]

Thanks for creating the issue in BuddyTrail! Before you start working on your PR, please make sure to:

• ⭐ Star the repository if you haven't already.
• Pull the latest changes to avoid any merge conflicts.

• Attach before & after screenshots in your PR for clarity.

  • Include the issue number in your PR description for better tracking. Don't forget to follow @PriyaGhosal – Project Admin – for more updates!

  We're excited to see your contribution as part of GSSOC Extended Edition 2024 and Hacktoberfest! 🎉
  Happy open-source contributing!

[github-actions[bot]]

Thank you for creating this issue! 🎉 Your issue will soon be reviewed by either the PA or a mentor. Please note that Level 1 is temporary and can be changed during the review. In the meantime, please make sure to provide all the necessary details and context. If you have any questions or additional information, feel free to add them here. Your contributions are highly appreciated! 😊

You can also check our CONTRIBUTING.md for guidelines on contributing to this project.