painy

Обезжиренный

 Comments for this repository commits are written with Painy itself.

Становите репозиторий, чтобы поддержать проект.

Функции

• Painy - это простой инструмент, который позволяет автоматически генерировать сообщения о коммите с помощью моделей OpenAI. Он автоматически проверяет поэтапные изменения в вашем репозитории и генерирует сообщение о коммите на основе изменений.

• Хорошо работает с ноутбуками Jupyter ( .ipynb ), используя nbdime для различия.

• Пейнси способен пересмотреть прошлые коммиты и создавать новые, которые следуют тому же стилю.

• Вы можете добавить свои собственные правила/запросы в качестве дополнительных подсказок для модели. Например, установите максимальное количество символов/предложений в сообщении Commit.

• Интерактивный режим.

Предварительные условия

• OpenAI API -ключ. Вы можете получить один здесь.

• Python 3.7.1 или выше и менеджер пакетов pip .

Установка

• Установите пакет через PIP:

  pip install painy

• Установите переменную среды OPENAI_API_KEY в свой ключ API OpenAI.

• По умолчанию Painy будет использовать gpt-3.5-turbo (CHATGPT), если вы хотите использовать другую модель, установите переменную среды OPENAI_MODEL_NAME для модели, которую вы хотите использовать. У вас должен быть доступ к модели, которую вы хотите использовать.

• Максимальная длина контекста зависит от используемой вами модели. Постарайтесь использовать инструмент на не слишком больших изменениях, в идеале на одном файле.

Использование

• (Рекомендуется) перейдите в папку с репозиторием и запустите следующую команду:

  • Добавьте что -нибудь на сцену:

    git add < files >

  • Затем используйте Painy:

    painy comment

  • Или с переменной среды OPENAI_API_KEY установлена ​​на место:

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

    Это будет генерировать сообщение о коммите на основе поэтапных изменений в вашем репозитории.

• Комплект поставленные изменения с созданным сообщением о коммите:

painy commit

• Интерактивный режим:

painy < comment | commit > -i

Это будет генерировать сообщение о коммите, основанное на поэтапных изменениях в вашем репозитории и спросит вас, хотите ли вы восстановить сообщение о коммите.

• Если вы хотите создать сообщение о коммите для всех изменений в вашем репозитории, запустите следующую команду (эти файлы должны быть зарегистрированы в GIT, чтобы иметь различие для сравнения):

painy < comment | commit > --check-all

• По умолчанию use_commit_history_style установлен на True . Если вы хотите отключить его, запустите следующую команду:

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

• Чтобы получить фактическое значение опции конфигурации. Запустите следующую команду:

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

• Список вариантов:

  • use_commit_history_style - использовать ли стиль первых коммитов в репозитории. По умолчанию он установлен на false . (Экспериментальный)
  • max_num_commits_style - максимальное количество последних коммитов для использования для стиля. По умолчанию это установлено в 5 .
  • max_characters (используется в качестве свойства в одном из правил по умолчанию) - желаемое максимальное количество символов в сообщении Commit. По умолчанию он установлен на 100 .

• Чтобы получить список правил. Запустите следующую команду:

  painy rules

  • Чтобы добавить новое правило. Запустите следующую команду:

    painy rules --add " Your own rule "

  • Чтобы удалить правило i-th из списка. Запустите следующую команду:

    painy rules --remove < i >