{"id":23105019,"url":"https://github.com/madhurimarawat/learning-codacy","last_synced_at":"2025-04-03T22:13:35.908Z","repository":{"id":264418943,"uuid":"893321488","full_name":"madhurimarawat/Learning-Codacy","owner":"madhurimarawat","description":"This repository is dedicated to learning about the code review automation tool Codacy, which helps improve code quality by analyzing codebases and providing actionable feedback.","archived":false,"fork":false,"pushed_at":"2024-11-24T12:52:37.000Z","size":892,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-02-09T10:11:17.229Z","etag":null,"topics":["automation","beginner","codacy","codacy-badge","codacy-integration","code-review","code-review-automation","codes","detailed-readme","discussions","documentation","installation-guide","learning-tool","markdown","open-source","output-explained","python","snapshots","software-engineering","study-materials"],"latest_commit_sha":null,"homepage":"https://www.codacy.com/","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/madhurimarawat.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}},"created_at":"2024-11-24T05:45:34.000Z","updated_at":"2024-11-24T12:52:40.000Z","dependencies_parsed_at":"2025-02-10T05:31:09.703Z","dependency_job_id":null,"html_url":"https://github.com/madhurimarawat/Learning-Codacy","commit_stats":null,"previous_names":["madhurimarawat/learning-codacy"],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/madhurimarawat%2FLearning-Codacy","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/madhurimarawat%2FLearning-Codacy/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/madhurimarawat%2FLearning-Codacy/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/madhurimarawat%2FLearning-Codacy/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/madhurimarawat","download_url":"https://codeload.github.com/madhurimarawat/Learning-Codacy/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":247086024,"owners_count":20881160,"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":["automation","beginner","codacy","codacy-badge","codacy-integration","code-review","code-review-automation","codes","detailed-readme","discussions","documentation","installation-guide","learning-tool","markdown","open-source","output-explained","python","snapshots","software-engineering","study-materials"],"created_at":"2024-12-17T00:37:21.516Z","updated_at":"2025-04-03T22:13:35.877Z","avatar_url":"https://github.com/madhurimarawat.png","language":"Python","readme":"# Learning Codacy\n\nThis repository is dedicated to learning about the code review automation tool **Codacy**, which helps improve code quality by analyzing codebases and providing actionable feedback.\n\n\u003cp align=\"center\"\u003e\n\u003ca href=\"https://app.codacy.com/gh/madhurimarawat/Learning-Codacy/dashboard?utm_source=gh\u0026utm_medium=referral\u0026utm_content=\u0026utm_campaign=Badge_grade\"\u003e\n    \u003cimg src=\"https://app.codacy.com/project/badge/Grade/c96266ba8f6d4386b486a474c429a5c4\" alt=\"Codacy Badge\"\u003e\n\u003c/a\u003e \u0026nbsp; \u0026nbsp;\n\u003ca href=\"https://github.com/madhurimarawat/Learning-Codacy\"\u003e\n    \u003cimg src=\"https://img.shields.io/github/repo-size/madhurimarawat/Learning-Codacy\" alt=\"GitHub repo size\"\u003e\n\u003c/a\u003e\n\u003c/p\u003e\n\n---\n\n## **Introduction**\n\n**Codacy** is an automated code review tool that integrates seamlessly with GitHub and other version control platforms. It performs static code analysis, identifies code smells, and enforces best practices to streamline development workflows.\n\n## **Steps to Set Up Codacy**\n\n### **1. Create an Account**\n1. Visit [Codacy](https://www.codacy.com/) and sign up using your **GitHub** account.\n   - Grant the necessary permissions for Codacy to access your repositories.\n2. After authorization, you will be redirected to the Codacy dashboard.\n\n\u003cimg src=\"https://github.com/user-attachments/assets/2bde1014-7316-44f0-a58b-375f9caa4cea\" width=\"100%\"\u003e\n\n---\n\n### **2. Add Your Repository**\n1. On the Codacy dashboard, click **\"Add a repository\"**.\n2. Select the repository (**Learning-Codacy**) you want Codacy to analyze.\n   - Ensure Codacy has the required access permissions.\n3. Codacy will perform an initial scan and generate a baseline report.\n\n\u003cimg src=\"https://github.com/user-attachments/assets/e558db92-74e4-4b78-9068-4dea1ffe3155\" width=\"100%\"\u003e\n\n---\n\n### **3. Test with Deliberate Code Issues**\nTo test Codacy’s capabilities, include intentional errors in your code, such as naming inconsistencies, duplication, or missing error handling. Observe how Codacy detects and reports these issues.\n\n\u003cimg src=\"https://github.com/user-attachments/assets/35182bbf-50ca-4d33-a357-954d25d341c5\" width=\"100%\"\u003e\n\n---\n\n### **4. Integrate Codacy with GitHub**\n1. Enable GitHub integration in Codacy:\n   - Go to **Settings \u003e Integrations** in your Codacy dashboard.\n   - Activate **GitHub Status Checks** to view analysis results directly in your pull requests.\n2. Once integrated, Codacy will provide feedback automatically during your development process.\n\n\u003cimg src=\"https://github.com/user-attachments/assets/b3926f11-5f87-459b-b42a-03bf427802cd\" width=\"100%\"\u003e\n\n---\n\n## Analysis and Evaluation\n\n### **Benefits of Integration**\n\n- **Automatic Code Reviews**: Save time by automating style and complexity checks.\n- **Feedback in Pull Requests**: View issues directly in GitHub pull requests.\n- **Customizable Rules**: Focus on the metrics that matter most for your project.\n- **Improved Code Quality**: Maintain consistent standards across your team.\n\n### **Example Workflow**\n\n1. Developer submits a pull request.\n2. CodeFactor/Codacy analyzes the code changes.\n3. Issues and suggestions are displayed directly in the pull request.\n4. Developer resolves the issues before merging.\n\n### **Troubleshooting**\n\n- **Analysis Not Triggering**: Ensure the repository is public or that the service has access to your private repository.\n  \n---\n\n## Directory Structure\n\n```\n📂 Learning-Codacy\n├── 📁 Codes\n│   ├── 📄 sample_code_corrected.py               # Testing script for the corrected workflow, ensuring proper functionality of the Streamlit app.\n│   ├── 📄 sample_code_with_errors.py             # Script demonstrating the erroneous workflow for analysis and debugging.\n│   ├── 📄 sample_code_with_errors_codefactor.py  # Script showcasing the error-prone workflow updated for CodeFactor review and improvements.\n│\n├── 📁 Documentation Files\n│   ├── 📄 Code Review Automation.md              # Sprint planning document outlining the development process and project timeline.\n│   ├── 📄 Code Review Automation.pdf             # A formatted PDF report summarizing project outputs and features for sharing and printing.\n│\n├── 📁 Output\n│   ├── 📄 Experiment 9 Output.docx               # Word document explaining the experiment's results in detail.\n│   ├── 📄 Experiment 9 Output.pdf                # PDF version of the experiment's outputs for easy distribution.\n│\n├── 📄 README.md                                  # Overview of the project, including purpose, setup instructions, and key features.\n├── 📄 LICENSE.md                                 # License information governing the usage, distribution, and modification of the project.\n```\n\n---\n\n## Thanks for Visiting 😄\n\n- Drop a 🌟 if you find this repository useful.\u003cbr\u003e\u003cbr\u003e\n- If you have any doubts or suggestions, feel free to reach me.\u003cbr\u003e\u003cbr\u003e\n📫 How to reach me:  \u0026nbsp; [![Linkedin Badge](https://img.shields.io/badge/-madhurima-blue?style=flat\u0026logo=Linkedin\u0026logoColor=white)](https://www.linkedin.com/in/madhurima-rawat/) \u0026nbsp; \u0026nbsp;\n\u003ca href =\"mailto:rawatmadhurima@gmail.com\"\u003e\u003cimg src=\"https://github.com/madhurimarawat/Machine-Learning-Using-Python/assets/105432776/b6a0873a-e961-42c0-8fbf-ab65828c961a\" height=35 width=30 title=\"Mail Illustration\" alt=\"Mail Illustration📫\" \u003e \u003c/a\u003e\u003cbr\u003e\u003cbr\u003e\n- **Contribute and Discuss:** Feel free to open \u003ca href= \"https://github.com/madhurimarawat/Learning-Codacy/issues\"\u003eissues 🐛\u003c/a\u003e, submit \u003ca href = \"https://github.com/madhurimarawat/Learning-Codacy/pulls\"\u003epull requests 🛠️\u003c/a\u003e, or start \u003ca href = \"https://github.com/madhurimarawat/Learning-Codacy/discussions\"\u003ediscussions 💬\u003c/a\u003e to help improve this repository!\n","funding_links":[],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmadhurimarawat%2Flearning-codacy","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fmadhurimarawat%2Flearning-codacy","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmadhurimarawat%2Flearning-codacy/lists"}