# Installation
You can install the latest version of AI Review Assistant from [GitHub](https://github.com/vvandriichuk/ai-review-assistant):
```bash
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 --ignore-settings-files/--review-all-files review
# You can put your own prompt to pyproject.toml:
```[tool.code_review_assistant]
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}.
"""
```
# Changelog
## [0.7.0] - 2024-07-27
### Added
- Added ignore_settings_files option to ignore settings files (toml, lock, md, txt, in, ini and that start from dot in the name)
## [0.6.2] - 2024-07-27
### Added
- Added missed rich library to dependencies list
## [0.6.1] - 2024-07-27
### Fixed
- 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:
## [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
[Unreleased]: https://github.com/vvandriichuk/ai-review-assistant/compare/v0.7.0...HEAD
[0.7.0]: https://github.com/vvandriichuk/ai-review-assistant/compare/v0.6.2...v0.7.0
[0.6.2]: https://github.com/vvandriichuk/ai-review-assistant/compare/v0.6.1...v0.6.2
[0.6.1]: https://github.com/vvandriichuk/ai-review-assistant/compare/v0.6.0...v0.6.1
[0.6.0]: https://github.com/vvandriichuk/ai-review-assistant/compare/v0.5.0...v0.6.0
[0.5.0]: https://github.com/vvandriichuk/ai-review-assistant/compare/v0.4.0...v0.5.0
[0.4.0]: https://github.com/vvandriichuk/ai-review-assistant/compare/v0.1.0...v0.4.0
[0.1.0]: https://github.com/vvandriichuk/ai-review-assistant/releases/tag/v0.1.0
Raw data
{
"_id": null,
"home_page": "https://github.com/vandriichuk/ai_review_assistant",
"name": "ai-review-assistant",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.11",
"maintainer_email": null,
"keywords": null,
"author": "Viktor Andriichuk",
"author_email": "v.andriichuk@gmail.com",
"download_url": "https://files.pythonhosted.org/packages/64/12/3c6558b6df8a0553e5455ee9bee6b661bac0872718a4e7b6103ac94527d0/ai_review_assistant-0.7.0.tar.gz",
"platform": null,
"description": "# Installation\n\nYou can install the latest version of AI Review Assistant from [GitHub](https://github.com/vvandriichuk/ai-review-assistant):\n\n```bash\npip install git+https://github.com/vvandriichuk/ai-review-assistant.git\n```\n\n# Help:\nai_review_assistant --help\n\n# Example of usage:\nai_review_assistant --vendor openai --model gpt-4o --api-key your_api_key --program-language \"Python,JavaScript,TypeScript\" --result-output-language English --ignore-settings-files/--review-all-files review\n\n# You can put your own prompt to pyproject.toml:\n\n```[tool.code_review_assistant]\nprompt_template = \"\"\"\nYou are an AI Code Review Assistant with expert knowledge of {program_language}. As a senior {program_language} developer, review the following code changes:\n\nProject Structure:\n{project_structure}\n\nFile being reviewed: {file_path}\n\nAnalyze the code changes considering these aspects:\n1. Code quality and readability\n2. Potential bugs or errors\n3. Performance implications\n4. Consistency with the overall project structure\n5. Suggestions for improvement\n6. Best practices specific to {program_language}\n\nInstructions for your response:\n- Provide a concise summary (about 4-6 points) of your overall findings.\n- Focus only on the most important or critical issues, if any.\n- Clearly state whether you found any critical issues that need immediate attention.\n- Include 1-2 key suggestions for improvement, if applicable.\n- If no significant issues were found, briefly mention that the changes look good, but still provide a suggestion for potential enhancement if possible.\n\nYour summary should be structured as follows:\n1. Overall assessment (1-2 points)\n2. Critical issues (if any) (1-2 points)\n3. Key suggestions for improvement (3-4 points)\n\nProvide your summary in {result_output_language}.\n\"\"\"\n```\n\n\n# Changelog\n\n## [0.7.0] - 2024-07-27\n### Added\n- Added ignore_settings_files option to ignore settings files (toml, lock, md, txt, in, ini and that start from dot in the name)\n\n## [0.6.2] - 2024-07-27\n### Added\n- Added missed rich library to dependencies list\n\n## [0.6.1] - 2024-07-27\n### Fixed\n- Fixed some minor bugs with versions and documentations\n\n## [0.6.0] - 2024-07-27\n### Added\n- You can put your own prompt to pyproject.toml file using [tool.code_review_assistant] block. Example of such block:\n\n## [0.5.0] - 2024-07-26\n### Added\n- You can check version of AI Review Assistant\n\n## [0.4.0] - 2024-07-26\n### Added\n- Added splitting long context by batch size\n- Added support for multiple languages\n- Added support for multiple models\n- You can run AI Review Assistant in any directory\n\n### Changed\n- Updated version of main dependencies libs\n\n## [0.1.0] - 2024-07-25\n### Added\n- Init library\n\n[Unreleased]: https://github.com/vvandriichuk/ai-review-assistant/compare/v0.7.0...HEAD\n[0.7.0]: https://github.com/vvandriichuk/ai-review-assistant/compare/v0.6.2...v0.7.0\n[0.6.2]: https://github.com/vvandriichuk/ai-review-assistant/compare/v0.6.1...v0.6.2\n[0.6.1]: https://github.com/vvandriichuk/ai-review-assistant/compare/v0.6.0...v0.6.1\n[0.6.0]: https://github.com/vvandriichuk/ai-review-assistant/compare/v0.5.0...v0.6.0\n[0.5.0]: https://github.com/vvandriichuk/ai-review-assistant/compare/v0.4.0...v0.5.0\n[0.4.0]: https://github.com/vvandriichuk/ai-review-assistant/compare/v0.1.0...v0.4.0\n[0.1.0]: https://github.com/vvandriichuk/ai-review-assistant/releases/tag/v0.1.0\n",
"bugtrack_url": null,
"license": null,
"summary": "An AI-powered code review assistant",
"version": "0.7.0",
"project_urls": {
"Homepage": "https://github.com/vandriichuk/ai_review_assistant"
},
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "9e45c65c01ec91f69deee50825bca13cda149533fac472197539c5ed4f3ef718",
"md5": "f2237ee8a0ea17e1e989eb291d0ecb43",
"sha256": "2834e7400f3b2e0332aea0e728f420147d0c46f2a29bc4ee4b1695158c5dd4e6"
},
"downloads": -1,
"filename": "ai_review_assistant-0.7.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "f2237ee8a0ea17e1e989eb291d0ecb43",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.11",
"size": 9947,
"upload_time": "2024-07-27T12:01:27",
"upload_time_iso_8601": "2024-07-27T12:01:27.267107Z",
"url": "https://files.pythonhosted.org/packages/9e/45/c65c01ec91f69deee50825bca13cda149533fac472197539c5ed4f3ef718/ai_review_assistant-0.7.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "64123c6558b6df8a0553e5455ee9bee6b661bac0872718a4e7b6103ac94527d0",
"md5": "600b63f64eb26e7693cb6985b695bec1",
"sha256": "9c91c4825151c7ee17488fc5a21fd07f52f39dace40d375c5b4a19cd8849dc58"
},
"downloads": -1,
"filename": "ai_review_assistant-0.7.0.tar.gz",
"has_sig": false,
"md5_digest": "600b63f64eb26e7693cb6985b695bec1",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.11",
"size": 89299,
"upload_time": "2024-07-27T12:01:28",
"upload_time_iso_8601": "2024-07-27T12:01:28.956246Z",
"url": "https://files.pythonhosted.org/packages/64/12/3c6558b6df8a0553e5455ee9bee6b661bac0872718a4e7b6103ac94527d0/ai_review_assistant-0.7.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-07-27 12:01:28",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "vandriichuk",
"github_project": "ai_review_assistant",
"github_not_found": true,
"lcname": "ai-review-assistant"
}
JSON
