{"id":28240605,"url":"https://github.com/datasherlock/helpme-readme","last_synced_at":"2025-06-12T09:32:31.693Z","repository":{"id":253377892,"uuid":"843324600","full_name":"datasherlock/helpme-readme","owner":"datasherlock","description":"This tool automatically generates README.md files for GitHub repositories using Google AI.","archived":false,"fork":false,"pushed_at":"2024-09-14T07:16:39.000Z","size":15,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-05-19T04:11:37.553Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"https://www.jeromerajan.com","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/datasherlock.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"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}},"created_at":"2024-08-16T09:09:32.000Z","updated_at":"2024-09-14T07:16:42.000Z","dependencies_parsed_at":"2024-09-14T18:43:06.230Z","dependency_job_id":null,"html_url":"https://github.com/datasherlock/helpme-readme","commit_stats":null,"previous_names":["datasherlock/helpme-readme"],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/datasherlock/helpme-readme","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/datasherlock%2Fhelpme-readme","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/datasherlock%2Fhelpme-readme/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/datasherlock%2Fhelpme-readme/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/datasherlock%2Fhelpme-readme/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/datasherlock","download_url":"https://codeload.github.com/datasherlock/helpme-readme/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/datasherlock%2Fhelpme-readme/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":259438762,"owners_count":22857586,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","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":[],"created_at":"2025-05-19T04:11:31.066Z","updated_at":"2025-06-12T09:32:31.685Z","avatar_url":"https://github.com/datasherlock.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"# AI-Powered README Generator\n\n\u003cimg width=\"735\" alt=\"Screenshot 2024-08-16 at 5 33 47 PM\" src=\"https://github.com/user-attachments/assets/5d650269-addd-4bd0-851e-ab29b0be9f36\"\u003e\n\nThis repository contains a Python script that automatically generates README.md files for GitHub repositories using Google AI. \n\n## Features\n\n* Clones a given GitHub repository.\n* Merges all code files into a single file for analysis.\n* Sends the merged code to Google AI's Gemini Pro model.\n* Uses a prompt engineered to generate human-like and informative README content.\n* Writes the generated README back to the cloned repository.\n\n## Dependencies\n\n* Python 3.7+\n* gitpython\n* google-cloud-aiplatform\n* vertexai\n\nYou can install the necessary packages using:\n\n```bash\npip install -r requirements.txt \n```\n\n## Usage\n\n1.  **Set up Google Cloud Project and Vertex AI API:**\n    *   Create a Google Cloud Project ([https://cloud.google.com/](https://cloud.google.com/)).\n    *   Enable the Vertex AI API.\n    *   Create a service account and download its JSON key file.\n    *   Set the `GOOGLE_APPLICATION_CREDENTIALS` environment variable to the path of your JSON key file:\n        ```bash \n        export GOOGLE_APPLICATION_CREDENTIALS=\"path/to/your/keyfile.json\"\n        ```\n\n2. **Get Repository URL:**\n    *   Get the repository URL from Github. This should be the complete path with the `.git` extension\n\n\n3. **Run the script:**\n\n   ```bash\n   python helpme_readme.py --repo_url=\u003cGithub URL\u003e\n   ```\n\nThe script will generate or update the `README.md` file in the cloned repository directory.\n\n## Disclaimer\n\n* The quality of the generated README depends on the complexity and clarity of the codebase.\n* This is an experimental tool and may require further refinement or customization.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdatasherlock%2Fhelpme-readme","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fdatasherlock%2Fhelpme-readme","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdatasherlock%2Fhelpme-readme/lists"}