Add Comprehensive Codebase Analysis API

[codegen-sh]

This PR adds a comprehensive codebase analysis API example that demonstrates how to leverage the Codegen SDK's powerful analysis capabilities to create a full-featured API for analyzing codebases.

Features

• API Server: A FastAPI-based server that provides endpoints for analyzing repositories and generating visualizations
• Comprehensive Analysis: Detailed metrics about codebase structure, quality, and dependencies
• Visualization Support: Generate visual representations of call graphs, dependency graphs, symbol trees, and more
• Issue Detection: Identify potential issues like unused code, circular dependencies, and high complexity functions
• Client Application: A command-line client that demonstrates how to use the API and display results

Implementation Details

The implementation includes:

1. API Server (api.py): Provides endpoints for analyzing repositories and generating visualizations
2. Client Application (client.py): A command-line tool for interacting with the API
3. Analysis View Mockup (ANALYSIS_VIEW_MOCKUP.md): Demonstrates how analysis results would be presented
4. Documentation (README.md): Explains how to use the API and client

This example showcases how the Codegen SDK can be used to build powerful static analysis tools that provide comprehensive insights into codebases.

---

💻 View my work • About Codegen

Summary by Sourcery

Add a comprehensive codebase analysis API that leverages the Codegen SDK to provide deep insights into code repositories, including analysis, visualization, and issue detection capabilities

New Features:

• Create a FastAPI-based server for analyzing code repositories
• Implement comprehensive codebase analysis with detailed metrics
• Add support for generating multiple types of code visualizations
• Develop a command-line client for interacting with the API

Enhancements:

• Implement advanced code quality issue detection
• Create flexible visualization options for codebase structure
• Add support for multiple programming languages
• Design a modular and extensible analysis framework

Documentation:

• Create a detailed README explaining API usage
• Add an analysis view mockup document demonstrating result presentation
• Include inline documentation for API endpoints and functions

[korbit-ai]

By default, I don't review pull requests opened by bots. If you would like me to review this pull request anyway, you can request a review via the /korbit-review command in a comment.

[sourcery-ai]

Reviewer's Guide

This pull request introduces a FastAPI server (api.py) that leverages the Codegen SDK to provide endpoints for analyzing codebase structure, quality, dependencies, and generating visualizations (like call graphs and dependency graphs). A command-line client (client.py) using the rich library is also included to interact with the API and display the analysis results.

File-Level Changes

Change	Details	Files
Implement FastAPI server for codebase analysis and visualization.	Defined FastAPI application with configuration for host, port, max size, and timeout. Created Pydantic models for requests (AnalysisRequest) and responses (AnalysisResponse). Implemented /analyze endpoints for remote GitHub URLs and local zip file uploads. Implemented /visualize endpoint to generate different graph types (call graph, dependency, symbol tree, etc.). Added helper functions to calculate metrics (complexity, Halstead, maintainability) using Codegen SDK objects. Added helper functions to find issues (unused code, complex functions) and build project structure trees. Integrated NetworkX for graph generation in visualizations. Added basic in-memory caching for analysis results.	codegen-examples/examples/codebase_analysis_api/api.py
Create a command-line client to interact with the analysis API.	Used argparse for command-line argument parsing (analyze, visualize). Utilized requests library to call the FastAPI endpoints. Employed rich library (Console, Table, Tree, Panel) to display analysis results and visualization data in a formatted way.	codegen-examples/examples/codebase_analysis_api/client.py
Add supporting documentation and configuration files.	Added README.md explaining the API features and usage. Included ANALYSIS_VIEW_MOCKUP.md to show example output presentation. Defined project dependencies in pyproject.toml and requirements.txt.	codegen-examples/examples/codebase_analysis_api/README.md codegen-examples/examples/codebase_analysis_api/ANALYSIS_VIEW_MOCKUP.md codegen-examples/examples/codebase_analysis_api/pyproject.toml codegen-examples/examples/codebase_analysis_api/requirements.txt

---

Tips and commands

Interacting with Sourcery

• Trigger a new review: Comment @sourcery-ai review on the pull request.
• Continue discussions: Reply directly to Sourcery's review comments.
• Generate a GitHub issue from a review comment: Ask Sourcery to create an
  issue from a review comment by replying to it. You can also reply to a
  review comment with @sourcery-ai issue to create an issue from it.
• Generate a pull request title: Write @sourcery-ai anywhere in the pull
  request title to generate a title at any time. You can also comment
  @sourcery-ai title on the pull request to (re-)generate the title at any time.
• Generate a pull request summary: Write @sourcery-ai summary anywhere in
  the pull request body to generate a PR summary at any time exactly where you
  want it. You can also comment @sourcery-ai summary on the pull request to
  (re-)generate the summary at any time.
• Generate reviewer's guide: Comment @sourcery-ai guide on the pull
  request to (re-)generate the reviewer's guide at any time.
• Resolve all Sourcery comments: Comment @sourcery-ai resolve on the
  pull request to resolve all Sourcery comments. Useful if you've already
  addressed all the comments and don't want to see them anymore.
• Dismiss all Sourcery reviews: Comment @sourcery-ai dismiss on the pull
  request to dismiss all existing Sourcery reviews. Especially useful if you
  want to start fresh with a new review - don't forget to comment
  @sourcery-ai review to trigger a new review!

Customizing Your Experience

Access your dashboard to:

• Enable or disable review features such as the Sourcery-generated pull request
  summary, the reviewer's guide, and others.
• Change the review language.
• Add, remove or edit custom review instructions.
• Adjust other review settings.

Getting Help

• Contact our support team for questions or feedback.
• Visit our documentation for detailed guides and information.
• Keep in touch with the Sourcery team by following us on X/Twitter, LinkedIn or GitHub.

[coderabbitai]

Important

Review skipped

Bot user detected.

To trigger a single review, invoke the @coderabbitai review command.

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.

---

🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

• Review comments: Directly reply to a review comment made by CodeRabbit. Example:
  • I pushed a fix in commit <commit_id>, please review it.
  • Generate unit testing code for this file.
  • Open a follow-up GitHub issue for this discussion.
• Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
  • @coderabbitai generate unit testing code for this file.
  • @coderabbitai modularize this function.
• PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
  • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
  • @coderabbitai read src/utils.ts and generate unit testing code.
  • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
  • @coderabbitai help me debug CodeRabbit configuration file.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

• @coderabbitai pause to pause the reviews on a PR.
• @coderabbitai resume to resume the paused reviews.
• @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
• @coderabbitai full review to do a full review from scratch and review all the files again.
• @coderabbitai summary to regenerate the summary of the PR.
• @coderabbitai generate sequence diagram to generate a sequence diagram of the changes in this PR.
• @coderabbitai resolve resolve all the CodeRabbit review comments.
• @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
• @coderabbitai help to get help.

Other keywords and placeholders

• Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
• Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
• Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

• You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
• Please see the configuration documentation for more information.
• If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

• Visit our Documentation for detailed information on how to use CodeRabbit.
• Join our Discord Community to get help, request features, and share feedback.
• Follow us on X/Twitter for updates and announcements.

[codegen-sh]

Hey! 👋 I see one of the checks failed. I am on it! 🫡

💻 View my work

[codegen-sh]

I see your interrupt message. I'll continue working on fixing the failing check suite in the PR. Is there something specific you'd like me to address or change in my approach?

💻 View my work • React 👍 or 👎

[codegen-sh]

Hey! 👋 I see one of the checks failed. I am on it! 🫡

💻 View my work

[codegen-sh]

I'm looking into the failing check suite for your PR "Add Comprehensive Codebase Analysis API". I'll examine what's causing the failure and provide a fix. Let me continue investigating.

💻 View my work

[codegen-sh]

I've fixed the issues that were causing the CI checks to fail in your PR. The main problems were:

1. End-of-file issues: Several files were missing a newline at the end, which I've added to:

   • ANALYSIS_VIEW_MOCKUP.md
   • README.md
   • requirements.txt

2. Unused imports in api.py:

   • Removed Union from the imports as it wasn't being used
   • Removed import plotly.graph_objects as go
   • Removed import json
   • Removed unused imports from codegen.sdk.codebase.codebase_analysis

3. Code formatting issues:

   • Fixed spacing between functions and classes
   • Removed extra whitespace

I've committed these changes and pushed them to your branch. The CI checks should now pass on the next run.

The PR looks great otherwise! It provides a comprehensive example of how to use the Codegen SDK for codebase analysis with a well-structured API and detailed documentation.

💻 View my work • React 👍 or 👎

[codegen-sh]

I see your message. Is there anything else you'd like me to explain or any other issues you'd like me to address with the PR? I'm happy to provide more details or make additional changes if needed.

💻 View my work

[codegen-sh]

Hey! 👋 I see one of the checks failed. I am on it! 🫡

💻 View my work

[codegen-sh]

I see your interrupt message. Let me pause my current analysis and respond to you. How can I help you?

💻 View my work

[codegen-sh]

I see your second interrupt message. I'll continue to wait for your instructions before proceeding with any further analysis or actions. Please let me know how you'd like me to proceed.

💻 View my work