Automate generate_readme.py: remove manual input, fix file listing, restore CI workflow#1
Open
devin-ai-integration[bot] wants to merge 1 commit intomainfrom
Open
Conversation
…estore CI workflow Co-Authored-By: liohnerd16 <liohnerd16@gmail.com>
Author
🤖 Devin AI EngineerI'll be helping with this pull request! Here's what you should know: ✅ I will automatically:
Note: I can only respond to comments from users who have write access to this repository. ⚙️ Control Options:
|
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
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.
Summary
Converts
generate_readme.pyfrom an interactive script (requiring 3input()calls) into a fully automated script that generatesREADME.mdwithout any manual input.Key changes:
input()calls — project name is auto-detected from the directory name; description and author are set as constants.os.path.dirname(os.path.abspath(__file__))so the script works correctly regardless of the current working directory. The old version usedos.listdir()which depended oncwdand could list incorrect files.IGNORED_NAMESset to exclude generated/hidden files (.git,.github,__pycache__, etc.).python main.py→python ocr_app.pyto match the actual entry point..github/workflows/generate-readme.yml) so the README is automatically regenerated on every push tomain.Review & Testing Checklist for Human
python generate_readme.pylocally and verify the generatedREADME.mdlists all expected files (currently:Screenshot 2025-05-13 183426.png,diagram.png,ocr_app.py,requirements.txt)mainand successfully commits an updated READMENotes
list_project_files,generate_readme) instead of top-level procedural code, making it easier to test and extend.IGNORED_NAMESset can be expanded if new generated/hidden files are added to the repo in the future.Link to Devin session: https://app.devin.ai/sessions/85a46d32a67645a086fc02185942f999
Requested by: @liohnerd16