| Name | git-wise JSON |
| Version |
0.1.4
JSON |
| download |
| home_page | None |
| Summary | AI-powered Git commit message generator |
| upload_time | 2024-10-20 06:43:17 |
| maintainer | None |
| docs_url | None |
| author | None |
| requires_python | >=3.7 |
| license | MIT License Copyright (c) 2024 creeponsky 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 |
git
commit
ai
openai
|
| VCS |
|
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# Git-wise
An AI-powered Git commit message generator that helps developers write meaningful and standardized commit messages.
[](https://badge.fury.io/py/git-wise)
[](https://opensource.org/licenses/MIT)
## Welcome to Git-Wise
Welcome to Git-Wise, a project born from the realization that my commit skills weren't quite up to par while developing another product! 😎 After about 10 hours of development, we now have this version.
Git-Wise uses GPT to analyze your staged files, automatically generate commit messages, and submit them! It's designed to enhance your Git workflow and improve the quality of your commit history.
As the project is still in the development stage, there may be some issues. However, if you encounter any problems or have ideas for improvement, please feel free to reach out and contribute your code!
> Fun fact: Every commit in this repository was crafted with the help of Git-Wise!🫡
### Support the Project
If you find Git-Wise helpful... 🤔
Unfortunately, I currently don't have any overseas payment methods 🥹🥹🥹
(But your moral support is greatly appreciated! )
<!-- [](https://www.buymeacoffee.com/creeponsky) -->
### Stay Connected
Follow me on Twitter for updates and more:
[](https://twitter.com/creeponsky)
Your feedback and contributions are what make open-source projects like Git-Wise thrive. Let's make commit messages great together!
## Features
- 🤖 AI-powered analysis of staged files to generate commit messages (currently using GPT-4O-mini)
- 🌍 Support for generating commits in multiple languages
- 🚀 Automatic commit submission
- 📏 Adjustable commit message detail level
## Installation
```bash
pip install git-wise
```
## Quick Start
1. Initialize git-wise:
```bash
git-wise init
```
2. Generate a commit message:
```bash
git add .
git-wise start
```
## Usage
### Basic Commands
```bash
# Initialize or reconfigure Git-Wise
git-wise init
# Generate commit message
git-wise start
# Generate commit message with specific options
git-wise start --language en --detail brief --interactive
# Check Git-Wise configuration and environment
git-wise doctor
# Show current configuration
git-wise show-config
# Show staged changes
git-wise show-diff
# Update specific configuration settings
git-wise config --default-language
git-wise config --detail-level
git-wise config --api-key
git-wise config --model
git-wise config --interactive
git-wise config --unlimited-chunk
```
### Configuration Options
- Language: Select your preferred language for commit messages
- Detail Level: Choose between brief, minimal, or detailed commit messages
- API Key: Set your OpenAI API key
- Model: Select the AI model to use
- Interactive Mode: Enable or disable interactive commit creation
- Unlimited Chunk: Enable or disable unlimited chunk mode(for large staged changes)
## Examples
### Detail Level
if you choose minimal:
if you choose brief:
if you choose detailed:
## Development
### Setup Development Environment
```bash
# Clone the repository
git clone https://github.com/creeponsky/git-wise.git
cd git-wise
# Create virtual environment
python -m venv venv
source venv/bin/activate # or `venv\Scripts\activate` on Windows
# Install development dependencies
pip install -e "."
```
### Running Tests
find a git repo you need to test, and run the following command:
```bash
cd /path/to/your/git/repo
git-wise init
git-wise start
```
## Contributing
We welcome contributions! Please see our [Contributing Guide](CONTRIBUTING.md) for details.
1. Fork the repository
2. Create your feature branch (`git checkout -b feature/amazing-feature`)
3. Commit your changes (`git commit -m 'Add some amazing feature'`)
4. Push to the branch (`git push origin feature/amazing-feature`)
5. Open a Pull Request
## License
This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.
## Acknowledgments
- OpenAI for providing the GPT API
- The Python community for excellent tools and libraries
## Support
- Visit our [website](https://git-wise.com) (currently under construction, but we'll add content soon! 😎)
- 📫 For bugs and feature requests, please [create an issue](https://github.com/creeponsky/git-wise/issues)
- 📧 For professional support, contact support@git-wise.dev
## Changelog
See [CHANGELOG.md](CHANGELOG.md) for all notable changes.
## Security
For security issues, please refer to our [Security Policy](SECURITY.md) and report them privately as described there.
Raw data
{
"_id": null,
"home_page": null,
"name": "git-wise",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.7",
"maintainer_email": null,
"keywords": "git, commit, AI, OpenAI",
"author": null,
"author_email": "creeponsky <creeponsky@gmail.com>",
"download_url": "https://files.pythonhosted.org/packages/cc/96/831f3fac88d6523ff636cf5f1a2437e201ec775724bca318364447f56155/git_wise-0.1.4.tar.gz",
"platform": null,
"description": "# Git-wise\n\nAn AI-powered Git commit message generator that helps developers write meaningful and standardized commit messages.\n\n[](https://badge.fury.io/py/git-wise)\n[](https://opensource.org/licenses/MIT)\n\n## Welcome to Git-Wise\n\nWelcome to Git-Wise, a project born from the realization that my commit skills weren't quite up to par while developing another product! \ud83d\ude0e After about 10 hours of development, we now have this version.\n\nGit-Wise uses GPT to analyze your staged files, automatically generate commit messages, and submit them! It's designed to enhance your Git workflow and improve the quality of your commit history.\n\nAs the project is still in the development stage, there may be some issues. However, if you encounter any problems or have ideas for improvement, please feel free to reach out and contribute your code!\n\n> Fun fact: Every commit in this repository was crafted with the help of Git-Wise!\ud83e\udee1\n\n### Support the Project \n\nIf you find Git-Wise helpful... \ud83e\udd14\n\nUnfortunately, I currently don't have any overseas payment methods \ud83e\udd79\ud83e\udd79\ud83e\udd79\n\n(But your moral support is greatly appreciated! )\n\n<!-- [](https://www.buymeacoffee.com/creeponsky) -->\n\n### Stay Connected\n\nFollow me on Twitter for updates and more:\n\n[](https://twitter.com/creeponsky)\n\nYour feedback and contributions are what make open-source projects like Git-Wise thrive. Let's make commit messages great together!\n\n\n## Features\n\n- \ud83e\udd16 AI-powered analysis of staged files to generate commit messages (currently using GPT-4O-mini)\n- \ud83c\udf0d Support for generating commits in multiple languages\n- \ud83d\ude80 Automatic commit submission\n- \ud83d\udccf Adjustable commit message detail level\n\n## Installation\n\n```bash\npip install git-wise\n```\n## Quick Start\n\n1. Initialize git-wise:\n```bash\ngit-wise init\n```\n\n2. Generate a commit message:\n```bash\ngit add .\ngit-wise start\n```\n\n## Usage\n\n### Basic Commands\n\n```bash\n# Initialize or reconfigure Git-Wise\ngit-wise init\n\n# Generate commit message\ngit-wise start\n\n# Generate commit message with specific options\ngit-wise start --language en --detail brief --interactive\n\n# Check Git-Wise configuration and environment\ngit-wise doctor\n\n# Show current configuration\ngit-wise show-config\n\n# Show staged changes\ngit-wise show-diff\n\n# Update specific configuration settings\ngit-wise config --default-language\ngit-wise config --detail-level\ngit-wise config --api-key\ngit-wise config --model\ngit-wise config --interactive\ngit-wise config --unlimited-chunk\n```\n\n### Configuration Options\n\n- Language: Select your preferred language for commit messages\n- Detail Level: Choose between brief, minimal, or detailed commit messages\n- API Key: Set your OpenAI API key\n- Model: Select the AI model to use\n- Interactive Mode: Enable or disable interactive commit creation\n- Unlimited Chunk: Enable or disable unlimited chunk mode(for large staged changes)\n\n## Examples\n### Detail Level\n\nif you choose minimal:\n\n\nif you choose brief:\n\n\nif you choose detailed:\n\n\n\n## Development\n\n### Setup Development Environment\n\n```bash\n# Clone the repository\ngit clone https://github.com/creeponsky/git-wise.git\ncd git-wise\n\n# Create virtual environment\npython -m venv venv\nsource venv/bin/activate # or `venv\\Scripts\\activate` on Windows\n\n# Install development dependencies\npip install -e \".\"\n```\n\n### Running Tests\nfind a git repo you need to test, and run the following command:\n```bash\ncd /path/to/your/git/repo\ngit-wise init\ngit-wise start\n```\n\n## Contributing\n\nWe welcome contributions! Please see our [Contributing Guide](CONTRIBUTING.md) for details.\n\n1. Fork the repository\n2. Create your feature branch (`git checkout -b feature/amazing-feature`)\n3. Commit your changes (`git commit -m 'Add some amazing feature'`)\n4. Push to the branch (`git push origin feature/amazing-feature`)\n5. Open a Pull Request\n\n## License\n\nThis project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.\n\n## Acknowledgments\n\n- OpenAI for providing the GPT API\n- The Python community for excellent tools and libraries\n\n## Support\n- Visit our [website](https://git-wise.com) (currently under construction, but we'll add content soon! \ud83d\ude0e)\n- \ud83d\udceb For bugs and feature requests, please [create an issue](https://github.com/creeponsky/git-wise/issues)\n- \ud83d\udce7 For professional support, contact support@git-wise.dev\n\n## Changelog\n\nSee [CHANGELOG.md](CHANGELOG.md) for all notable changes.\n\n## Security\n\nFor security issues, please refer to our [Security Policy](SECURITY.md) and report them privately as described there.\n",
"bugtrack_url": null,
"license": "MIT License Copyright (c) 2024 creeponsky 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. ",
"summary": "AI-powered Git commit message generator",
"version": "0.1.4",
"project_urls": null,
"split_keywords": [
"git",
" commit",
" ai",
" openai"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "2f34f2f906ea9920ab00bc258d8cdac9aa6299ebd1e892d4a69a326738d96655",
"md5": "0df4e81102158c8a16695c1fb8374030",
"sha256": "c0f007c05bd465a8319ac7b09c1fe0a1b675bd4c93e67d3441bf232499b07183"
},
"downloads": -1,
"filename": "git_wise-0.1.4-py3-none-any.whl",
"has_sig": false,
"md5_digest": "0df4e81102158c8a16695c1fb8374030",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.7",
"size": 19274,
"upload_time": "2024-10-20T06:43:15",
"upload_time_iso_8601": "2024-10-20T06:43:15.720145Z",
"url": "https://files.pythonhosted.org/packages/2f/34/f2f906ea9920ab00bc258d8cdac9aa6299ebd1e892d4a69a326738d96655/git_wise-0.1.4-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "cc96831f3fac88d6523ff636cf5f1a2437e201ec775724bca318364447f56155",
"md5": "e477c0fb43311cc6726b629ab38c53d3",
"sha256": "c9febd0cc070d571d0d83763a0115df0c16e11c3f4f066e4db6b644536e7308b"
},
"downloads": -1,
"filename": "git_wise-0.1.4.tar.gz",
"has_sig": false,
"md5_digest": "e477c0fb43311cc6726b629ab38c53d3",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.7",
"size": 19617,
"upload_time": "2024-10-20T06:43:17",
"upload_time_iso_8601": "2024-10-20T06:43:17.315997Z",
"url": "https://files.pythonhosted.org/packages/cc/96/831f3fac88d6523ff636cf5f1a2437e201ec775724bca318364447f56155/git_wise-0.1.4.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-10-20 06:43:17",
"github": false,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"lcname": "git-wise"
}
