Skip to main content

Git tools for Commitizen and PR Summary Generation using AI

Project description

Cometa Git Tools

Una colección de herramientas Git para mejorar el flujo de trabajo de desarrollo, incluyendo un generador de mensajes de commit basado en AI y un generador/creador de Pull Requests.

Características

  • 🤖 AI Conventional Commits: Genera mensajes de commit siguiendo la convención de Conventional Commits usando Google Gemini AI
  • 📝 PR Manager: Genera y crea Pull Requests automáticamente con resúmenes inteligentes
  • 🎨 Interfaz Amigable: Interfaz de línea de comandos intuitiva y colorida
  • 🔧 Fácil Configuración: Comando cz-setup para configurar todo automáticamente

Instalación

Usando pip

pip install cometa-git-tools

Instalación desde el código fuente

git clone https://github.com/cometa/cometa-git-tools.git
cd cometa-git-tools
pip install -e .

Configuración

  1. Configura tu API key de Google Gemini:
export GEMINI_API_KEY='your-api-key'
  1. (Opcional) Agrega la variable a tu archivo .bashrc o .zshrc para hacerla permanente:
echo 'export GEMINI_API_KEY="your-api-key"' >> ~/.zshrc  # o ~/.bashrc
  1. Configura Commitizen para usar el plugin AI:
# Configuración rápida (recomendado)
cz-setup

# Opciones avanzadas:
cz-setup --help         # Ver todas las opciones disponibles
cz-setup --no-global   # Solo configurar el proyecto actual
cz-setup --no-project  # Solo configurar globalmente

Archivos de Configuración

El comando cz-setup creará/modificará dos archivos:

  1. ~/.commitizen/config.toml: Configuración global de commitizen
  2. ./pyproject.toml: Configuración local del proyecto

Uso

Commitizen AI

Este plugin extiende Commitizen para generar mensajes de commit usando AI:

# Agrega tus cambios
git add .

# Genera un mensaje de commit con AI
cz commit

PR Summary Generator

Herramienta completa para gestionar Pull Requests:

# Genera un resumen del PR actual para poder visualizarlo en el editor de texto
pr-summary generate

# Crea un nuevo PR con resumen automático
pr-summary create

# Crea un PR especificando la rama base
pr-summary create --base main

# Ver todas las opciones disponibles
pr-summary --help

La herramienta permite:

  • 📝 Generar resúmenes detallados de los cambios
  • ✨ Crear PRs directamente desde la línea de comandos
  • 🔄 Especificar la rama base del PR
  • 🤖 Generar títulos y descripciones usando AI

Desarrollo

Para contribuir al proyecto:

  1. Clona el repositorio
  2. Instala las dependencias de desarrollo:
pip install -e ".[dev]"
  1. Ejecuta los tests:
pytest

Licencia

MIT License - ver LICENSE para más detalles.

Contribuir

Las contribuciones son bienvenidas! Por favor, lee CONTRIBUTING.md para detalles sobre nuestro código de conducta y el proceso para enviar pull requests.

Soporte

Si encuentras algún problema o tienes una sugerencia, por favor crea un issue en el repositorio de GitHub.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

cometa_git_tools-0.1.9.tar.gz (13.0 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

cometa_git_tools-0.1.9-py3-none-any.whl (12.8 kB view details)

Uploaded Python 3

File details

Details for the file cometa_git_tools-0.1.9.tar.gz.

File metadata

  • Download URL: cometa_git_tools-0.1.9.tar.gz
  • Upload date:
  • Size: 13.0 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.12.6

File hashes

Hashes for cometa_git_tools-0.1.9.tar.gz
Algorithm Hash digest
SHA256 a1082764040eab8e85ba76fd76bba08c62df5944e85262bc07c4b1499a9140b2
MD5 aec4fa690f0e3e662b2b0693f7a3ae60
BLAKE2b-256 2a8a65287c11a04ad78e35400d3203bc336de589e7bb221adb64fa5b23a5c95f

See more details on using hashes here.

File details

Details for the file cometa_git_tools-0.1.9-py3-none-any.whl.

File metadata

File hashes

Hashes for cometa_git_tools-0.1.9-py3-none-any.whl
Algorithm Hash digest
SHA256 0f2923350d4d0a6c2b10edd781be7eb5b28b11a86bd7f2b01382fef70998f856
MD5 1abf247b6b826608abfd9c8e1023773f
BLAKE2b-256 09ed62df963c651c1c482c8cb52cb7a327abec4a8d23935e747632b0a05a3eb5

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page