{"id":23609798,"url":"https://github.com/jeffrine/code-review-writer","last_synced_at":"2026-04-09T16:34:02.629Z","repository":{"id":269684001,"uuid":"849680023","full_name":"JeffrinE/Code-Review-Writer","owner":"JeffrinE","description":"The Code-Review-Writer project is an innovative tool designed to streamline the process of creating and editing documentation for projects. By integrating with llms, it offers a seamless experience in generating high-quality content that adheres to best practices in documentation.","archived":false,"fork":false,"pushed_at":"2024-12-25T09:13:07.000Z","size":31,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"master","last_synced_at":"2024-12-25T10:23:02.812Z","etag":null,"topics":["code-to-text","github","llm","ollama","python","readme-generator","streamlit"],"latest_commit_sha":null,"homepage":"","language":"Python","has_issues":false,"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/JeffrinE.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-30T03:30:45.000Z","updated_at":"2024-12-25T09:13:10.000Z","dependencies_parsed_at":"2024-12-25T10:23:04.330Z","dependency_job_id":"b6d3f8a6-1a54-448f-a115-43b6f57430c5","html_url":"https://github.com/JeffrinE/Code-Review-Writer","commit_stats":null,"previous_names":["jeffrine/code-review-writer"],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/JeffrinE%2FCode-Review-Writer","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/JeffrinE%2FCode-Review-Writer/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/JeffrinE%2FCode-Review-Writer/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/JeffrinE%2FCode-Review-Writer/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/JeffrinE","download_url":"https://codeload.github.com/JeffrinE/Code-Review-Writer/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":239475957,"owners_count":19645041,"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":["code-to-text","github","llm","ollama","python","readme-generator","streamlit"],"created_at":"2024-12-27T15:14:38.482Z","updated_at":"2025-11-05T22:30:30.260Z","avatar_url":"https://github.com/JeffrinE.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Project Description: \n## Code-Review-Writer\n\nThe Code-Review-Writer project is an innovative tool designed to streamline the process of creating and editing documentation for projects. By integrating with llms, it offers a seamless experience in generating high-quality content that adheres to best practices in documentation.\n\n---\n# Features:\n## Local Model Integration \n- Leverages local models for content generation by reducing reliance on external services, enhancing privacy.\n## Markdown Formatting \n- Employs markdown3 styling to ensure the generated README files are visually appealing and easy to read across various platforms.\n## In-App Editing \n- Leverages the conversational ability of LLMs to \nemploy content editing In-app.\n## Customizable sub header sequence \n- Allows user to  select sub headers in desired order.\n## Exclude Unnecessary Folders \n- Employs filters to exclude selected folders from being used in the documentation. \n\n---\n# How It Works:\nThe Github-ReadMe-Writer tool follows a simple workflow for generating README content:\n\n## Local Model Integration \n- By integrating with local models like Ollama, the tool offers faster content generation while maintaining high-quality output. Users can easily customize their LLMs to suit their project's needs without relying on external services.\n## Easy Content Editing and Management \n- The Github-ReadMe-Writer provides an intuitive interface for users to edit, manage, and update their README files effortlessly. This ensures that the content remains up-to-date with any changes in the project's development or usage.\n\n---\n# Installation\n\nInstall streamlit using, \n\n```\npip install streamlit\n```\n\nExecute the project using, \n\n```\nstreamlit run run.py\n```\n\n---\n\n__NOTE:__ \nWait until each action is finished executing shown by the 'Running' icon on the top right. \n\n---\n\n# Conclusion:\nThe Github-ReadMe-Writer is a comprehensive solution designed for developers who want to create professional, informative README files effortlessly. With its advanced features and easy-to-use interface, it simplifies content generation while maintaining high standards of quality and style.\n\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fjeffrine%2Fcode-review-writer","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fjeffrine%2Fcode-review-writer","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fjeffrine%2Fcode-review-writer/lists"}