painy

Doloroso

 Comments for this repository commits are written with Painy itself.

Estrela o repositório para apoiar o projeto.

Características

• Dor é uma ferramenta simples que permite gerar automaticamente mensagens de compromisso com a ajuda dos modelos OpenAI. Ele verifica automaticamente as alterações encenadas no seu repositório e gera uma mensagem de confirmação com base nas alterações.

• Funciona bem com os notebooks Jupyter (arquivos .ipynb ) usando nbdime para diffing.

• Doligioso é capaz de revisar os compromissos do passado e criar novos que seguem o mesmo estilo.

• Você pode adicionar suas próprias regras/solicitações como instruções adicionais para o modelo. Por exemplo, defina o número máximo de caracteres/frases na mensagem de confirmação.

• Modo interativo.

Pré -requisitos

• Chave da API OpenAI. Você pode conseguir um aqui.

• Python 3.7.1 ou superior e gerenciador de pacotes pip .

Instalação

• Instale o pacote via PIP:

  pip install painy

• Defina a variável de ambiente OPENAI_API_KEY na sua tecla API OpenAI.

• Por padrão, o doloroso usará o gpt-3.5-turbo (chatgpt), se você deseja usar um modelo diferente, defina a variável de ambiente OPENAI_MODEL_NAME para o modelo que deseja usar. Você deve ter acesso ao modelo que deseja usar.

• O comprimento máximo do contexto depende do modelo que você usa. Tente usar a ferramenta em alterações não muito grandes, idealmente em um único arquivo.

Uso

• (Recomendado) Vá para a pasta com seu repositório e execute o seguinte comando:

  • Adicione algo ao palco:

    git add < files >

  • Em seguida, use doloroso:

    painy comment

  • Ou com a variável de ambiente OPENAI_API_KEY STIP EMPLAPE:

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

    Isso gerará uma mensagem de confirmação com base nas alterações encenadas em seu repositório.

• Comprometer mudanças encenadas com uma mensagem de compromisso gerada:

painy commit

• Modo interativo:

painy < comment | commit > -i

Isso gerará uma mensagem de confirmação com base nas alterações encenadas em seu repositório e perguntará se você deseja regenerar a mensagem de confirmação.

• Se você deseja gerar uma mensagem de confirmação para todas as alterações no seu repositório, execute o seguinte comando (esses arquivos devem ser registrados no Git antes para ter um diferencial para comparar):

painy < comment | commit > --check-all

• Por padrão, o use_commit_history_style está definido como True . Se você deseja desativá -lo, execute o seguinte comando:

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

• Para obter o valor real da opção de configuração, execute o seguinte comando:

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

• Lista de opções:

  • use_commit_history_style - Se você deve usar o estilo dos primeiros começos no repositório. Por padrão, ele está definido como false . (Experimental)
  • max_num_commits_style - o número máximo de comprimentos últimos a usar para o estilo. Por padrão, ele está definido como 5 .
  • max_characters (usado como uma propriedade em uma das regras padrão) - o número máximo desejado de caracteres na mensagem de confirmação. Por padrão, ele está definido como 100 .

• Para obter a lista de regras executar o seguinte comando:

  painy rules

  • Para adicionar uma nova regra, execute o seguinte comando:

    painy rules --add " Your own rule "

  • Para remover a regra da lista da lista, execute o seguinte comando:

    painy rules --remove < i >