An AI-powered code review assistant
Project description
Installation
You can install the latest version of AI Review Assistant from GitHub:
pip install git+https://github.com/vvandriichuk/ai-review-assistant.git
Help:
ai_review_assistant --help
Example of usage:
ai_review_assistant --vendor openai --model gpt-4o --api-key your_api_key --program-language "Python,JavaScript,TypeScript" --result-output-language English review
Changelog
0.6.1 - 2024-07-27
Added
- Fixed some minor bugs with versions and documentations
0.6.0 - 2024-07-27
Added
- You can put your own prompt to pyproject.toml file using [tool.code_review_assistant] block. Example of such block:
prompt_template = """
You are an AI Code Review Assistant with expert knowledge of {program_language}. As a senior {program_language} developer, review the following code changes:
Project Structure:
{project_structure}
File being reviewed: {file_path}
Analyze the code changes considering these aspects:
1. Code quality and readability
2. Potential bugs or errors
3. Performance implications
4. Consistency with the overall project structure
5. Suggestions for improvement
6. Best practices specific to {program_language}
Instructions for your response:
- Provide a concise summary (about 4-6 points) of your overall findings.
- Focus only on the most important or critical issues, if any.
- Clearly state whether you found any critical issues that need immediate attention.
- Include 1-2 key suggestions for improvement, if applicable.
- If no significant issues were found, briefly mention that the changes look good, but still provide a suggestion for potential enhancement if possible.
Your summary should be structured as follows:
1. Overall assessment (1-2 points)
2. Critical issues (if any) (1-2 points)
3. Key suggestions for improvement (3-4 points)
Provide your summary in {result_output_language}.
"""
0.5.0 - 2024-07-26
Added
- You can check version of AI Review Assistant
0.4.0 - 2024-07-26
Added
- Added splitting long context by batch size
- Added support for multiple languages
- Added support for multiple models
- You can run AI Review Assistant in any directory
Changed
- Updated version of main dependencies libs
0.1.0 - 2024-07-25
Added
- Init library
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
ai_review_assistant-0.6.1.tar.gz
(88.4 kB
view hashes)
Built Distribution
Close
Hashes for ai_review_assistant-0.6.1.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 439e552c40685f7a010a5729593962611809be5af899e73deea60ccb8b7ec4c5 |
|
MD5 | e2541aab72a52172419442e5d24d9118 |
|
BLAKE2b-256 | b9bfed2adef527f3909f3f5a36b669a96caf77bf1f27212e0a770d9928009e68 |
Close
Hashes for ai_review_assistant-0.6.1-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 949d276c83463da1311509fe4ebeaea29c277cc0a11c8e53885ec5fb677e8d86 |
|
MD5 | d6a9c677acce5d371883923d4b0c9a20 |
|
BLAKE2b-256 | cc5bf99adc42edafffe03bde2d450ebcc8306b1d0e0a6319cf5c70280a14a8dc |