painy

Doloroso

 Comments for this repository commits are written with Painy itself.

Estrella el repositorio para admitir el proyecto.

Características

• Painy es una herramienta simple que le permite generar automáticamente mensajes de confirmación con la ayuda de los modelos Operai. Verifica automáticamente los cambios en su repositorio y genera un mensaje de confirmación basado en los cambios.

• Funciona bien con los cuadernos Jupyter (archivos .ipynb ) utilizando nbdime para la difusión.

• Painy es capaz de revisar las confirmaciones pasadas y crear nuevas que sigan el mismo estilo.

• Puede agregar sus propias reglas/solicitudes como indicaciones adicionales para el modelo. Por ejemplo, establezca el número máximo de caracteres/oraciones en el mensaje de confirmación.

• Modo interactivo.

Requisitos previos

• Clave de API de OpenAI. Puedes conseguir uno aquí.

• Python 3.7.1 o superior y administrador de paquetes pip .

Instalación

• Instale el paquete a través de PIP:

  pip install painy

• Establezca la variable de entorno OPENAI_API_KEY en su tecla API OpenAI.

• De forma predeterminada, Painy usará el gpt-3.5-turbo (CHATGPT), si desea usar un modelo diferente, configure la variable de entorno OPENAI_MODEL_NAME en el modelo que desea usar. Debe tener acceso al modelo que desea usar.

• La longitud de contexto máximo depende del modelo que use. Intente usar la herramienta en cambios no demasiado grandes, idealmente en un solo archivo.

Uso

• (Recomendado) Vaya a la carpeta con su repositorio y ejecute el siguiente comando:

  • Agregue algo al escenario:

    git add < files >

  • Entonces usa dolor:

    painy comment

  • O con la variable de entorno OPENAI_API_KEY set Inplace:

    OPENAI_API_KEY= < your-openai-api-key > painy comment

    Esto generará un mensaje de confirmación basado en los cambios en su repositorio.

• Cometer cambios escenificados con un mensaje de confirmación generado:

painy commit

• Modo interactivo:

painy < comment | commit > -i

Esto generará un mensaje de confirmación basado en los cambios en su repositorio y le preguntará si desea regenerar el mensaje de confirmación.

• Si desea generar un mensaje de confirmación para todos los cambios en su repositorio, ejecute el siguiente comando (estos archivos deben registrarse en GIT antes para tener una diferencia para comparar):

painy < comment | commit > --check-all

• Por defecto, el use_commit_history_style se establece en True . Si desea deshabilitarlo, ejecute el siguiente comando:

  painy config --set use-commit-history-style False

• Para obtener el valor real de la opción de configuración, ejecute el siguiente comando:

  painy config --get use-commit-history-style

• Lista de opciones:

  • use_commit_history_style : si se debe usar el estilo de los committes anteriores en el repositorio. Por defecto, se establece en false . (Experimental)
  • max_num_commits_style : el número máximo de los últimos compromisos para usar para el estilo. Por defecto, se establece en 5 .
  • max_characters (utilizado como propiedad en una de reglas predeterminadas): el número máximo deseado de caracteres en el mensaje de confirmación. Por defecto, se establece en 100 .

• Para obtener la lista de reglas, ejecute el siguiente comando:

  painy rules

  • Para agregar una nueva regla, ejecute el siguiente comando:

    painy rules --add " Your own rule "

  • Para eliminar la regla I-th de la lista, ejecute el siguiente comando:

    painy rules --remove < i >