{"id":15142592,"url":"https://github.com/anou1234/fastapi_code_docu_analyzer","last_synced_at":"2026-01-20T20:12:01.338Z","repository":{"id":257277150,"uuid":"857796447","full_name":"anou1234/Fastapi_code_docu_analyzer","owner":"anou1234","description":"This project is a FastAPI application leveraging the power of the Gemini's Generative AI API that allows users to upload a project folder (in ZIP format) for code and README analysis. The application evaluates the quality of the code, generates improved code suggestions, and assesses the quality of the README documentation. ","archived":false,"fork":false,"pushed_at":"2024-09-20T20:08:32.000Z","size":61,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-02-12T21:49:12.049Z","etag":null,"topics":["assignment-checker","code-analysis-tool","code-analyzer","documentation-analysis-tool","fastapi","generative-ai"],"latest_commit_sha":null,"homepage":"","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/anou1234.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-09-15T16:25:59.000Z","updated_at":"2024-09-20T20:08:36.000Z","dependencies_parsed_at":null,"dependency_job_id":"17c1521a-bc8a-4292-9f47-fbf31c425a82","html_url":"https://github.com/anou1234/Fastapi_code_docu_analyzer","commit_stats":{"total_commits":18,"total_committers":1,"mean_commits":18.0,"dds":0.0,"last_synced_commit":"861f0ad8524492151e304bf961073e0b4fb263fd"},"previous_names":["anou1234/fastapi_code_docu_analyzer"],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/anou1234%2FFastapi_code_docu_analyzer","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/anou1234%2FFastapi_code_docu_analyzer/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/anou1234%2FFastapi_code_docu_analyzer/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/anou1234%2FFastapi_code_docu_analyzer/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/anou1234","download_url":"https://codeload.github.com/anou1234/Fastapi_code_docu_analyzer/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":247509164,"owners_count":20950233,"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":["assignment-checker","code-analysis-tool","code-analyzer","documentation-analysis-tool","fastapi","generative-ai"],"created_at":"2024-09-26T09:42:59.494Z","updated_at":"2026-01-20T20:12:01.309Z","avatar_url":"https://github.com/anou1234.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Intern Assignment checker - GenAI \u0026 FastAPI Based Code \u0026 Documentation Analyzer\n\n## Overview\n\nThis project is a FastAPI application leveraging the power of the Gemini's Generative AI API that allows users to upload a project folder (in ZIP format) for code and README analysis. The application evaluates the quality of the code, generates improved code suggestions, and assesses the quality of the README documentation. The results are presented through a web interface, making it easy for developers to understand the strengths and weaknesses of their projects.\n\n## Table of Contents\n\n- [Requirements](#requirements)\n- [Installation](#installation)\n- [Usage](#usage)\n- [Code Analysis](#code-analysis)\n- [README Analysis](#readme-analysis)\n- [Contributing](#contributing)\n- [Contact](#contact)\n- [Webapp Screenshots](#webapp-screenshots)\n\n## Requirements \n\n- **Python**: Version 3.8 or higher\n- **FastAPI**: Web framework for building APIs\n- **Uvicorn**: ASGI server for running the FastAPI application\n- **Gemini API** : Gemini's Generative AI API for code \u0026 documentation analysis\n\n## Installation\n\n1. **Clone the Repository**\n\n   Open your terminal and clone the repository:\n\n   ```bash\n   git clone https://github.com/anou1234/Fastapi_code_docu_analyzer.git\n   cd my_fastapi_project\n   ```\n\n2. **Set up a Virtual Environment**\n\n   Create and activate a virtual environment:\n\n   ```bash\n   python -m venv venv\n   source venv/bin/activate  # On Windows use `venv\\Scripts\\activate`\n   ```\n3. **Install Dependencies**\n\n   Use `pip` to install the required packages:\n\n   ```bash\n   pip install -r requirements.txt\n   ```\n\n\n## Usage\n\n1. **Start the Application**\n\n   Run the FastAPI application using Uvicorn:\n\n   ```bash\n   uvicorn main:app --reload\n   ```\n\n2. **Access the Application**\n\n   Open your web browser and navigate to:\n\n   ```\n   http://127.0.0.1:8000\n   ```\n\n3. **Upload a Project Folder**\n\n   Use the web interface to upload a ZIP file containing the project you wish to analyze.\n\n## Code Analysis\n\nThe application analyzes the submitted code for various quality metrics, including but not limited to:\n\n- **Code Complexity**: Evaluates the complexity of the code to ensure maintainability.\n- **Readability**: Checks the readability and structure of the code.\n- **Improved Code Suggestions**: Provides suggestions for improved code practices and patterns.\n\n## README Analysis\n\nThe application also evaluates the README documentation to ensure it is informative and well-structured. The analysis includes:\n\n- Clarity of project overview\n- Proper usage instructions\n- Dependencies and installation steps\n- Contribution guidelines\n![image]()\n\n## Contributing\n\nContributions are welcome! If you'd like to help improve this project, please follow these steps:\n\n1. **Fork the Repository**: Create your copy of the repository on GitHub.\n2. **Create a Branch**: Work on your feature or fix:\n3. **Commit Your Changes**: Keep your commits clear and concise.\n4. **Push to Your Branch**: \n5. **Submit a Pull Request**: Share your changes with the main project.\n## Webapp Screenshots\n\u003cimg src=\"https://github.com/user-attachments/assets/eb0ef7d7-7423-4912-a897-b8e6046f5941\" alt=\"Screenshot 2024-09-15 214027\" width=\"600\" height=\"300\"\u003e\n\u003cimg src=\"https://github.com/user-attachments/assets/d006fd9c-f31d-496c-ab7a-23e7886748d9\" alt=\"Screenshot 2024-09-15 214125\" width=\"600\" height=\"300\"\u003e\n\u003cimg src=\"https://github.com/user-attachments/assets/84786eb4-f52d-4e01-b18c-cf9cd15121c9\" alt=\"Screenshot 2024-09-15 214139\" width=\"600\" height=\"300\"\u003e\n\n## Contact\n\n- **Author**: Anoushka Srivastava\n- **Email**: anoushkathegreat28@gmail.com/anoushka.srivastava.21cse@bmu.edu.in\n- **GitHub**: [anou1234](https://github.com/anou1234)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fanou1234%2Ffastapi_code_docu_analyzer","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fanou1234%2Ffastapi_code_docu_analyzer","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fanou1234%2Ffastapi_code_docu_analyzer/lists"}