| Name | vumit JSON |
| Version |
1.0.0
JSON |
| download |
| home_page | None |
| Summary | AI-powered Git analysis tool using Gemini AI |
| upload_time | 2025-02-27 15:56:50 |
| maintainer | None |
| docs_url | None |
| author | Vumit Contributors |
| requires_python | >=3.9 |
| license | MIT License
Copyright (c) 2025 Vumit Contributors
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE. |
| keywords |
ai
code-review
git
merge-request
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# Vumit - AI-powered Git Analysis Tool
Vumit is a command-line tool that uses Google's Gemini AI to analyze Git changes and generate merge request descriptions.
Version: 0.1.0
## Installation
```bash
pip install -e .
```
## Configuration
Vumit requires a Google Gemini API key to function. There are several ways to configure this:
1. Environment Variable (Recommended for Development):
```bash
export GEMINI_API_KEY='your-api-key'
```
2. Configuration File (Recommended for Production):
Create a file at `~/.config/vumit/config.ini`:
```ini
[gemini]
api_key = your-api-key
```
Never commit your API key to version control or include it directly in your code.
## Usage
### Commands
1. Check code changes:
```bash
vumit check
```
or
```bash
vumit check --target <target-branch> # Default: dev
```
Analyzes diff commits (compared with target branch) in your Git repository and provides AI-powered recommendations.
2. Generate merge request description:
```bash
vumit report
```
or
```bash
vumit report --target <target-branch> # Default: dev
```
Generates a detailed merge request description based on your changes and repository context.
## Requirements
- Python 3.9 or higher
- Git repository
- Google Gemini API key
## License
This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.
Raw data
{
"_id": null,
"home_page": null,
"name": "vumit",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.9",
"maintainer_email": null,
"keywords": "ai, code-review, git, merge-request",
"author": "Vumit Contributors",
"author_email": null,
"download_url": null,
"platform": null,
"description": "# Vumit - AI-powered Git Analysis Tool\n\nVumit is a command-line tool that uses Google's Gemini AI to analyze Git changes and generate merge request descriptions.\n\nVersion: 0.1.0\n\n## Installation\n\n```bash\npip install -e .\n```\n\n## Configuration\n\nVumit requires a Google Gemini API key to function. There are several ways to configure this:\n\n1. Environment Variable (Recommended for Development):\n ```bash\n export GEMINI_API_KEY='your-api-key'\n ```\n\n2. Configuration File (Recommended for Production):\n Create a file at `~/.config/vumit/config.ini`:\n ```ini\n [gemini]\n api_key = your-api-key\n ```\n\nNever commit your API key to version control or include it directly in your code.\n\n## Usage\n\n### Commands\n\n1. Check code changes:\n```bash\nvumit check\n```\nor\n```bash\nvumit check --target <target-branch> # Default: dev\n```\n\nAnalyzes diff commits (compared with target branch) in your Git repository and provides AI-powered recommendations.\n\n2. Generate merge request description:\n```bash\nvumit report\n```\nor\n\n```bash\nvumit report --target <target-branch> # Default: dev\n```\nGenerates a detailed merge request description based on your changes and repository context.\n\n## Requirements\n\n- Python 3.9 or higher\n- Git repository\n- Google Gemini API key\n\n## License\n\nThis project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.",
"bugtrack_url": null,
"license": "MIT License\n \n Copyright (c) 2025 Vumit Contributors\n \n Permission is hereby granted, free of charge, to any person obtaining a copy\n of this software and associated documentation files (the \"Software\"), to deal\n in the Software without restriction, including without limitation the rights\n to use, copy, modify, merge, publish, distribute, sublicense, and/or sell\n copies of the Software, and to permit persons to whom the Software is\n furnished to do so, subject to the following conditions:\n \n The above copyright notice and this permission notice shall be included in all\n copies or substantial portions of the Software.\n \n THE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR\n IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,\n FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE\n AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER\n LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,\n OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE\n SOFTWARE.",
"summary": "AI-powered Git analysis tool using Gemini AI",
"version": "1.0.0",
"project_urls": {
"Documentation": "https://github.com/vumit/vumit#readme",
"Issues": "https://github.com/vumit/vumit/issues"
},
"split_keywords": [
"ai",
" code-review",
" git",
" merge-request"
],
"urls": [
{
"comment_text": null,
"digests": {
"blake2b_256": "ad25873d7844b4d78bc62699edf411efe98eb1fb4e4e53b32babf555e5bc26f5",
"md5": "3e11a5e0525d32b22f516989af43bbd4",
"sha256": "35e248e5b0c1769b09c6007dfdc9f6174ac50cec5e1b1a12abe9b5ef0427c774"
},
"downloads": -1,
"filename": "vumit-1.0.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "3e11a5e0525d32b22f516989af43bbd4",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.9",
"size": 9113,
"upload_time": "2025-02-27T15:56:50",
"upload_time_iso_8601": "2025-02-27T15:56:50.878493Z",
"url": "https://files.pythonhosted.org/packages/ad/25/873d7844b4d78bc62699edf411efe98eb1fb4e4e53b32babf555e5bc26f5/vumit-1.0.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2025-02-27 15:56:50",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "vumit",
"github_project": "vumit#readme",
"github_not_found": true,
"lcname": "vumit"
}
