painy

痛苦

 Comments for this repository commits are written with Painy itself.

主角存储库以支持该项目。

特征

• Painsy是一个简单的工具，可让您在OpenAI模型的帮助下自动生成提交消息。它会自动检查存储库中的分阶段更改，并根据更改生成提交消息。

• 通过使用nbdime进行分散，可以与jupyter笔记本电脑（ .ipynb文件）合作。

• Painy能够审查过去的投入并创建遵循相同风格的新提交。

• 您可以将自己的规则/请求添加为模型的其他提示。例如，在提交消息中设置最大数量的字符/句子。

• 交互式模式。

先决条件

• OpenAI API键。你可以在这里得到一个。

• Python 3.7.1或更高和pip软件包管理器。

安装

• 通过PIP安装软件包：

  pip install painy

• 将环境变量OPENAI_API_KEY设置为OpenAI API键。

• 默认情况下，Painy将使用gpt-3.5-turbo （ChatGpt），如果要使用其他模型，请将环境变量OPENAI_MODEL_NAME设置为要使用的模型。您必须访问要使用的型号。

• 最大上下文长度取决于您使用的模型。尝试使用该工具不太大的更改，理想情况下是一个文件。

用法

• （建议）使用您的存储库转到文件夹，然后运行以下命令：

  • 在舞台上添加一些东西：

    git add < files >

  • 然后使用痛苦：

    painy comment

  • 或使用环境变量OPENAI_API_KEY设置Inploph：

    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 （默认规则之一中用作属性） - 提交消息中所需的最大字符数。默认情况下，它设置为100 。

• 要获取规则列表运行以下命令：

  painy rules

  • 要添加新规则运行以下命令：

    painy rules --add " Your own rule "

  • 要从列表中删除第i-th规则，请运行以下命令：

    painy rules --remove < i >