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 >