{"id":29625308,"url":"https://github.com/leo-capvano/describe-a-python-project","last_synced_at":"2026-05-04T20:33:29.231Z","repository":{"id":238112459,"uuid":"795901984","full_name":"leo-capvano/describe-a-python-project","owner":"leo-capvano","description":"Describe each file of a python project by asking a Generative AI model to generate a natural language explanation of each file","archived":false,"fork":false,"pushed_at":"2024-05-05T18:25:16.000Z","size":255,"stargazers_count":0,"open_issues_count":0,"forks_count":1,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-07-21T06:50:25.731Z","etag":null,"topics":["generative-ai","generative-ai-tools","langchain","langchain-openai","langchain-python","prompt-template","python","streamlit"],"latest_commit_sha":null,"homepage":"https://github.com/leo-capvano/describe-a-python-project","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/leo-capvano.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null}},"created_at":"2024-05-04T11:20:43.000Z","updated_at":"2024-05-05T18:25:20.000Z","dependencies_parsed_at":"2024-05-04T12:28:27.317Z","dependency_job_id":"cc34817d-1630-4320-93ed-b7d2f63b5998","html_url":"https://github.com/leo-capvano/describe-a-python-project","commit_stats":null,"previous_names":["leo-capvano/describe-a-python-project"],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/leo-capvano/describe-a-python-project","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/leo-capvano%2Fdescribe-a-python-project","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/leo-capvano%2Fdescribe-a-python-project/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/leo-capvano%2Fdescribe-a-python-project/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/leo-capvano%2Fdescribe-a-python-project/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/leo-capvano","download_url":"https://codeload.github.com/leo-capvano/describe-a-python-project/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/leo-capvano%2Fdescribe-a-python-project/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":32624196,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-05-04T10:08:07.713Z","status":"ssl_error","status_checked_at":"2026-05-04T10:08:02.005Z","response_time":58,"last_error":"SSL_read: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["generative-ai","generative-ai-tools","langchain","langchain-openai","langchain-python","prompt-template","python","streamlit"],"created_at":"2025-07-21T06:35:34.145Z","updated_at":"2026-05-04T20:33:29.193Z","avatar_url":"https://github.com/leo-capvano.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"# describe-a-python-project\nDescribe each file of a python project by asking a Generative AI model to generate a natural language explanation\n\n## Need\n- an OpenAI API Key and the relative environment variable OPENAI_API_KEY\n\n## How\n\u003e pip install -r requirements.txt  \n\u003e streamlit run gui.py\n\n## Guide\n- copy and paste the folder you want to analyze recursively inside the text box:\n![img.png](res%2Fimg.png)\n\n### An Alternative GUI\nYou can choose to run a python GUI that allows you to select a local folder.  \nChoose a local folder:  \n![pygui1.png](res%2Fpygui1.png)  \nDescriptions generated for each file:  \n![pygui2.png](res%2Fpygui2.png)\n### Notes\nThe procedure does not recursively visit all the folders; you can exclude teh files and the folders you don't want to analyze by\nadding those names to the constants EXCLUDED_FOLDER_NAMES, EXCLUDED_FILENAMES\n\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fleo-capvano%2Fdescribe-a-python-project","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fleo-capvano%2Fdescribe-a-python-project","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fleo-capvano%2Fdescribe-a-python-project/lists"}