Skip to main content

An AI Code Review tool using OpenAI

Project description

CodeCriticAI

CodeCriticAI is a tool for performing AI-powered code reviews using Git diffs. It leverages OpenAI's API to analyze code changes and generate detailed reviews.

Features

  • Analyzes code changes using Git diffs
  • Utilizes OpenAI's API for code review
  • Generates HTML reports of the code review

Requirements

  • Python 3.6+
  • OpenAI API key
  • Git

Installation

  1. Clone the repository:

    git clone https://github.com/mihir20/CodeCriticAI.git
    cd CodeCriticAI
    
  2. Install the required Python packages:

    pip install -r requirements.txt
    
  3. Set up your OpenAI API key:

    export OPENAI_API_KEY='your-api-key'
    

Usage

Run the main script with the required arguments:

python codecriticAI/main.py --dir <directory_path> [--base <base_branch>]

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

codecriticai-0.0.1.tar.gz (6.2 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

codecriticai-0.0.1-py3-none-any.whl (7.4 kB view details)

Uploaded Python 3

File details

Details for the file codecriticai-0.0.1.tar.gz.

File metadata

  • Download URL: codecriticai-0.0.1.tar.gz
  • Upload date:
  • Size: 6.2 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.13.2

File hashes

Hashes for codecriticai-0.0.1.tar.gz
Algorithm Hash digest
SHA256 5bc2f7a9100e0eb9b11e585fabf2dc21c4e9f25967041e3cdc2350c8a0458f8b
MD5 97190b54cb6904e0360e45bb2e0721cd
BLAKE2b-256 bc9123646f37215ff483c47396a4bda0d0651e8548f89c9932304856044379c8

See more details on using hashes here.

File details

Details for the file codecriticai-0.0.1-py3-none-any.whl.

File metadata

  • Download URL: codecriticai-0.0.1-py3-none-any.whl
  • Upload date:
  • Size: 7.4 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.13.2

File hashes

Hashes for codecriticai-0.0.1-py3-none-any.whl
Algorithm Hash digest
SHA256 48591e182b457ad3bc3b56b6f98a5cffc656fe322c5b5f2effbb49748e0b7583
MD5 04456447c3503b0e2676e8fc54066ba7
BLAKE2b-256 afa2d23f1d828dbab34b81f60b6b14d800406119dbcb5c57daddcaaa6aa5dd7d

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page