| Name | conventional-commits-generator JSON |
| Version |
2.2.4
JSON |
| download |
| home_page | None |
| Summary | Interactive CLI tool for creating standardized commit messages following conventional commits |
| upload_time | 2025-08-30 15:11:01 |
| maintainer | None |
| docs_url | None |
| author | None |
| requires_python | >=3.8 |
| license | MIT License
Copyright (c) 2025 Egydio Bolonhezi
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 |
cli
commit
conventional-commits
developer-tools
git
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# Conventional Commits Generator
<div align="center">
<img src="https://github.com/EgydioBNeto/conventional-commits-generator/assets/84047984/53f38934-16bb-40f6-aff7-a5800c4bd706" width="300px"/>
</div>
## Description
Interactive CLI tool for creating standardized commit messages following the [conventional commits](https://www.conventionalcommits.org/) format. Includes support for commit body, emojis, and advanced commit management features.
## Installation
### Using pipx (recommended)
```bash
pipx install conventional-commits-generator
```
### Using pip
```bash
pip install conventional-commits-generator
```
### Development installation
```bash
# Clone the GitHub repository
git clone https://github.com/EgydioBNeto/conventional-commits-generator.git
# Navigate into the project directory
cd conventional-commits-generator
# Grant execute permission to the virtual environment setup script
chmod +x scripts/setup_venv.sh
# Run the script to create and set up the virtual environment
./scripts/setup_venv.sh
# Activate the virtual environment
source .venv/bin/activate
```
## Usage
### Basic commands
```bash
# Create interactive commit
ccg
# Generate commit message without committing
ccg --commit
# Push only without creating commit
ccg --push
# Edit existing commit
ccg --edit
# Delete existing commit
ccg --delete
# Create and push tag
ccg --tag
# Reset local and pull from remote
ccg --reset
# Show version
ccg --version
```
### Interactive usage example
```
$ ccg
________ ________ ________
|\ ____\ |\ ____\ |\ ____\
\ \ \___| \ \ \___| \ \ \___|
\ \ \ \ \ \ \ \ \ ___
\ \ \____ \ \ \____ \ \ \|\ \
\ \_______\ \ \_______\ \ \_______\
\|_______| \|_______| \|_______|
Conventional Commits Generator
┌──────────────────────┐
│ Commit Types │
└──────────────────────┘
1. ✨ feat - A new feature
2. 🐛 fix - A bug fix
3. 🔧 chore - Maintenance tasks
4. ♻️ refactor - Code refactoring
5. 💄 style - Style changes
6. 📚 docs - Documentation
...
Choose the commit type: 1
┌──────────────────────┐
│ Scope │
└──────────────────────┘
Enter the scope (optional): auth
┌──────────────────────┐
│ Breaking Change │
└──────────────────────┘
Is this a BREAKING CHANGE? (y/n): n
┌──────────────────────┐
│ Emoji │
└──────────────────────┘
Include emoji in commit message? (y/n): n
┌──────────────────────┐
│ Commit Message │
└──────────────────────┘
Enter the commit message: implement OAuth login
┌──────────────────────┐
│ Commit Body │
└──────────────────────┘
Commit body (optional): Added Google OAuth 2.0 support
Integration with existing user system
┌──────────────────────┐
│ Review │
└──────────────────────┘
┌─────────────────────────────────────────────────────────┐
│ │
│ feat(auth): implement OAuth login │
│ │
│ Added Google OAuth 2.0 support │
│ Integration with existing user system │
│ │
└─────────────────────────────────────────────────────────┘
Confirm this commit message? (y/n): y
✓ New commit successfully created!
Do you want to push these changes? (y/n): y
✓ Changes pushed successfully!
```
## Commit Types
| Type | Emoji | Description |
|------|-------|-------------|
| `feat` | ✨ | A new feature |
| `fix` | 🐛 | A bug fix |
| `chore` | 🔧 | Maintenance tasks |
| `refactor` | ♻️ | Code refactoring |
| `style` | 💄 | Style/formatting changes |
| `docs` | 📚 | Documentation changes |
| `test` | 🧪 | Adding or modifying tests |
| `build` | 📦 | Build system changes |
| `revert` | ⏪ | Reverts a previous commit |
| `ci` | 👷 | CI/CD changes |
| `perf` | ⚡ | Performance improvements |
## Requirements
- Python 3.8+
- Git
## Contributing
See [CONTRIBUTING.md](.github/CONTRIBUTING.md) for details on how to contribute.
## Code of Conduct
Please read our [Code of Conduct](.github/CODE_OF_CONDUCT.md) for details on our community standards.
## Security
To report security vulnerabilities, see [SECURITY.md](.github/SECURITY.md).
## License
This project is licensed under the [MIT License](LICENSE).
## Author
[EgydioBNeto](https://github.com/EgydioBNeto)
Raw data
{
"_id": null,
"home_page": null,
"name": "conventional-commits-generator",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.8",
"maintainer_email": null,
"keywords": "cli, commit, conventional-commits, developer-tools, git",
"author": null,
"author_email": "Egydio Bolonhezi <egydiobolonhezi@gmail.com>",
"download_url": "https://files.pythonhosted.org/packages/5d/ee/e36826ac59a17a50812296253321f9054176d916e8f7c50c65820cf40f9c/conventional_commits_generator-2.2.4.tar.gz",
"platform": null,
"description": "# Conventional Commits Generator\n\n<div align=\"center\">\n<img src=\"https://github.com/EgydioBNeto/conventional-commits-generator/assets/84047984/53f38934-16bb-40f6-aff7-a5800c4bd706\" width=\"300px\"/>\n</div>\n\n## Description\n\nInteractive CLI tool for creating standardized commit messages following the [conventional commits](https://www.conventionalcommits.org/) format. Includes support for commit body, emojis, and advanced commit management features.\n\n## Installation\n\n### Using pipx (recommended)\n```bash\npipx install conventional-commits-generator\n```\n\n### Using pip\n```bash\npip install conventional-commits-generator\n```\n\n### Development installation\n```bash\n# Clone the GitHub repository\ngit clone https://github.com/EgydioBNeto/conventional-commits-generator.git\n\n# Navigate into the project directory\ncd conventional-commits-generator\n\n# Grant execute permission to the virtual environment setup script\nchmod +x scripts/setup_venv.sh\n\n# Run the script to create and set up the virtual environment\n./scripts/setup_venv.sh\n\n# Activate the virtual environment\nsource .venv/bin/activate\n```\n\n## Usage\n\n### Basic commands\n\n```bash\n# Create interactive commit\nccg\n\n# Generate commit message without committing\nccg --commit\n\n# Push only without creating commit\nccg --push\n\n# Edit existing commit\nccg --edit\n\n# Delete existing commit\nccg --delete\n\n# Create and push tag\nccg --tag\n\n# Reset local and pull from remote\nccg --reset\n\n# Show version\nccg --version\n```\n\n### Interactive usage example\n\n```\n$ ccg\n\n ________ ________ ________\n|\\ ____\\ |\\ ____\\ |\\ ____\\\n\\ \\ \\___| \\ \\ \\___| \\ \\ \\___|\n \\ \\ \\ \\ \\ \\ \\ \\ \\ ___\n \\ \\ \\____ \\ \\ \\____ \\ \\ \\|\\ \\\n \\ \\_______\\ \\ \\_______\\ \\ \\_______\\\n \\|_______| \\|_______| \\|_______|\n\n Conventional Commits Generator\n\n\u250c\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2510\n\u2502 Commit Types \u2502\n\u2514\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2518\n\n1. \u2728 feat - A new feature\n2. \ud83d\udc1b fix - A bug fix\n3. \ud83d\udd27 chore - Maintenance tasks\n4. \u267b\ufe0f refactor - Code refactoring\n5. \ud83d\udc84 style - Style changes\n6. \ud83d\udcda docs - Documentation\n...\n\nChoose the commit type: 1\n\n\u250c\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2510\n\u2502 Scope \u2502\n\u2514\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2518\nEnter the scope (optional): auth\n\n\u250c\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2510\n\u2502 Breaking Change \u2502\n\u2514\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2518\nIs this a BREAKING CHANGE? (y/n): n\n\n\u250c\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2510\n\u2502 Emoji \u2502\n\u2514\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2518\nInclude emoji in commit message? (y/n): n\n\n\u250c\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2510\n\u2502 Commit Message \u2502\n\u2514\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2518\nEnter the commit message: implement OAuth login\n\n\u250c\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2510\n\u2502 Commit Body \u2502\n\u2514\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2518\nCommit body (optional): Added Google OAuth 2.0 support\nIntegration with existing user system\n\n\u250c\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2510\n\u2502 Review \u2502\n\u2514\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2518\n\n\u250c\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2510\n\u2502 \u2502\n\u2502 feat(auth): implement OAuth login \u2502\n\u2502 \u2502\n\u2502 Added Google OAuth 2.0 support \u2502\n\u2502 Integration with existing user system \u2502\n\u2502 \u2502\n\u2514\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2518\n\nConfirm this commit message? (y/n): y\n\u2713 New commit successfully created!\n\nDo you want to push these changes? (y/n): y\n\u2713 Changes pushed successfully!\n```\n\n## Commit Types\n\n| Type | Emoji | Description |\n|------|-------|-------------|\n| `feat` | \u2728 | A new feature |\n| `fix` | \ud83d\udc1b | A bug fix |\n| `chore` | \ud83d\udd27 | Maintenance tasks |\n| `refactor` | \u267b\ufe0f | Code refactoring |\n| `style` | \ud83d\udc84 | Style/formatting changes |\n| `docs` | \ud83d\udcda | Documentation changes |\n| `test` | \ud83e\uddea | Adding or modifying tests |\n| `build` | \ud83d\udce6 | Build system changes |\n| `revert` | \u23ea | Reverts a previous commit |\n| `ci` | \ud83d\udc77 | CI/CD changes |\n| `perf` | \u26a1 | Performance improvements |\n\n## Requirements\n\n- Python 3.8+\n- Git\n\n## Contributing\n\nSee [CONTRIBUTING.md](.github/CONTRIBUTING.md) for details on how to contribute.\n\n## Code of Conduct\n\nPlease read our [Code of Conduct](.github/CODE_OF_CONDUCT.md) for details on our community standards.\n\n## Security\n\nTo report security vulnerabilities, see [SECURITY.md](.github/SECURITY.md).\n\n## License\n\nThis project is licensed under the [MIT License](LICENSE).\n\n## Author\n\n[EgydioBNeto](https://github.com/EgydioBNeto)\n",
"bugtrack_url": null,
"license": "MIT License\n \n Copyright (c) 2025 Egydio Bolonhezi\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": "Interactive CLI tool for creating standardized commit messages following conventional commits",
"version": "2.2.4",
"project_urls": {
"Changelog": "https://github.com/EgydioBNeto/conventional-commits-generator/releases",
"Homepage": "https://github.com/EgydioBNeto/conventional-commits-generator",
"Issues": "https://github.com/EgydioBNeto/conventional-commits-generator/issues",
"Repository": "https://github.com/EgydioBNeto/conventional-commits-generator"
},
"split_keywords": [
"cli",
" commit",
" conventional-commits",
" developer-tools",
" git"
],
"urls": [
{
"comment_text": null,
"digests": {
"blake2b_256": "d62d7465b624e357d4cebaf909480c9c66f2b6ab7a55d905662372e54a6d0f21",
"md5": "d0876446e2e6727d9574359315cf50aa",
"sha256": "157a9d06ec226d03897ed8076babe0a96cf7160ea6fe6ebe2b109c1dad181ecf"
},
"downloads": -1,
"filename": "conventional_commits_generator-2.2.4-py3-none-any.whl",
"has_sig": false,
"md5_digest": "d0876446e2e6727d9574359315cf50aa",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.8",
"size": 23793,
"upload_time": "2025-08-30T15:11:00",
"upload_time_iso_8601": "2025-08-30T15:11:00.020665Z",
"url": "https://files.pythonhosted.org/packages/d6/2d/7465b624e357d4cebaf909480c9c66f2b6ab7a55d905662372e54a6d0f21/conventional_commits_generator-2.2.4-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": null,
"digests": {
"blake2b_256": "5deee36826ac59a17a50812296253321f9054176d916e8f7c50c65820cf40f9c",
"md5": "5e3291777c0edd67c60e1bfb55520ee3",
"sha256": "5926fa66d5ec4a8a6d1e75ad5f9fa04c2b86bfe7345c36e392731fb2298efa5b"
},
"downloads": -1,
"filename": "conventional_commits_generator-2.2.4.tar.gz",
"has_sig": false,
"md5_digest": "5e3291777c0edd67c60e1bfb55520ee3",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.8",
"size": 37347,
"upload_time": "2025-08-30T15:11:01",
"upload_time_iso_8601": "2025-08-30T15:11:01.334103Z",
"url": "https://files.pythonhosted.org/packages/5d/ee/e36826ac59a17a50812296253321f9054176d916e8f7c50c65820cf40f9c/conventional_commits_generator-2.2.4.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2025-08-30 15:11:01",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "EgydioBNeto",
"github_project": "conventional-commits-generator",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "conventional-commits-generator"
}
