painy

Doué

 Comments for this repository commits are written with Painy itself.

Mettez en vedette le référentiel pour soutenir le projet.

Caractéristiques

• Painy est un outil simple qui vous permet de générer automatiquement des messages de validation à l'aide de modèles OpenAI. Il vérifie automatiquement les modifications de votre référentiel et génèrent un message de validation en fonction des modifications.

• Fonctionne bien avec Jupyter Notebook ( .ipynb Files) en utilisant nbdime pour diffuser.

• Painy est capable de revoir les commits passés et de créer de nouveaux qui suivent le même style.

• Vous pouvez ajouter vos propres règles / demandes en tant qu'invites supplémentaires pour le modèle. Par exemple, définissez le nombre maximum de caractères / phrases dans le message de validation.

• Mode interactif.

Condition préalable

• Clé API Openai. Vous pouvez en obtenir un ici.

• Python 3.7.1 ou plus et pip Package Manager.

Installation

• Installez le package via PIP:

  pip install painy

• Définissez la variable d'environnement OPENAI_API_KEY sur votre touche API OpenAI.

• Par défaut, Painy utilisera le gpt-3.5-turbo (Chatgpt), si vous souhaitez utiliser un modèle différent, définissez la variable d'environnement OPENAI_MODEL_NAME sur le modèle que vous souhaitez utiliser. Vous devez avoir accès au modèle que vous souhaitez utiliser.

• La longueur du contexte maximum dépend du modèle que vous utilisez. Essayez d'utiliser l'outil sur des modifications pas trop grandes, idéalement sur un seul fichier.

Usage

• (Recommandé) Accédez au dossier avec votre référentiel et exécutez la commande suivante:

  • Ajoutez quelque chose à la scène:

    git add < files >

  • Puis utilisez Painy:

    painy comment

  • Ou avec la variable d'environnement OPENAI_API_KEY SET en place:

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

    Cela générera un message de validation basé sur les modifications de votre référentiel.

• Commit les modifications mise en scène avec un message de validation généré:

painy commit

• Mode interactif:

painy < comment | commit > -i

Cela générera un message de validation basé sur les modifications de votre référentiel et vous demandera si vous souhaitez régénérer le message de validation.

• Si vous souhaitez générer un message de validation pour toutes les modifications de votre référentiel, exécutez la commande suivante (ces fichiers doivent être enregistrés dans Git avant afin d'avoir un diff à comparer):

painy < comment | commit > --check-all

• Par défaut, le use_commit_history_style est défini sur True . Si vous souhaitez le désactiver, exécutez la commande suivante:

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

• Pour obtenir la valeur réelle de l'option de configuration, exécutez la commande suivante:

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

• Liste des options:

  • use_commit_history_style - s'il faut utiliser le style des anciens commits dans le référentiel. Par défaut, il est défini sur false . (Expérimental)
  • max_num_commits_style - Le nombre maximum de derniers engage à utiliser pour le style. Par défaut, il est défini sur 5 .
  • max_characters (utilisé comme propriété dans l'une des règles par défaut) - le nombre maximum de caractères souhaité dans le message de validation. Par défaut, il est défini sur 100 .

• Pour obtenir la liste des règles, exécutez la commande suivante:

  painy rules

  • Pour ajouter une nouvelle règle, exécutez la commande suivante:

    painy rules --add " Your own rule "

  • Pour supprimer la i-ème règle de la liste, exécutez la commande suivante:

    painy rules --remove < i >