painy

Painy

 Comments for this repository commits are written with Painy itself.

Bintangi repositori untuk mendukung proyek.

Fitur

• Painy adalah alat sederhana yang memungkinkan Anda untuk secara otomatis menghasilkan pesan komit dengan bantuan model OpenAI. Secara otomatis memeriksa perubahan bertahap dalam repositori Anda dan menghasilkan pesan komit berdasarkan perubahan.

• Bekerja dengan baik dengan Jupyter Notebooks ( .ipynb file) dengan menggunakan nbdime untuk difing.

• Painy mampu meninjau komitmen masa lalu dan menciptakan yang baru yang mengikuti gaya yang sama.

• Anda dapat menambahkan aturan/permintaan Anda sendiri sebagai permintaan tambahan untuk model. Misalnya, atur jumlah maksimum karakter/kalimat dalam pesan komit.

• Mode interaktif.

Prasyarat

• Kunci API Openai. Anda bisa mendapatkannya di sini.

• Python 3.7.1 atau lebih tinggi dan pip Paket Manager.

Instalasi

• Instal paket melalui PIP:

  pip install painy

• Atur Variabel Lingkungan OPENAI_API_KEY ke kunci API OpenAI Anda.

• Secara default, Painy akan menggunakan gpt-3.5-turbo (chatgpt), jika Anda ingin menggunakan model yang berbeda, atur variabel lingkungan OPENAI_MODEL_NAME ke model yang ingin Anda gunakan. Anda harus memiliki akses ke model yang ingin Anda gunakan.

• Panjang konteks maks tergantung pada model yang Anda gunakan. Cobalah untuk menggunakan alat ini pada perubahan yang tidak terlalu besar, idealnya pada satu file.

Penggunaan

• (Disarankan) Pergi ke folder dengan repositori Anda dan jalankan perintah berikut:

  • Tambahkan sesuatu ke panggung:

    git add < files >

  • Kemudian gunakan Painy:

    painy comment

  • Atau dengan variabel lingkungan OPENAI_API_KEY SET INPLOCE:

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

    Ini akan menghasilkan pesan komit berdasarkan perubahan bertahap dalam repositori Anda.

• Melakukan perubahan bertahap dengan pesan komit yang dihasilkan:

painy commit

• Mode Interaktif:

painy < comment | commit > -i

Ini akan menghasilkan pesan komit berdasarkan perubahan bertahap dalam repositori Anda dan akan menanyakan apakah Anda ingin meregenerasi pesan komit.

• Jika Anda ingin membuat pesan komit untuk semua perubahan dalam repositori Anda, jalankan perintah berikut (file ini harus didaftarkan di git sebelumnya untuk memiliki diff untuk membandingkan):

painy < comment | commit > --check-all

• Secara default, use_commit_history_style diatur ke True . Jika Anda ingin menonaktifkannya, jalankan perintah berikut:

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

• Untuk mendapatkan nilai aktual opsi konfigurasi, jalankan perintah berikut:

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

• Daftar Opsi:

  • use_commit_history_style - apakah akan menggunakan gaya komitmen sebelumnya di repositori. Secara default diatur ke false . (Eksperimental)
  • max_num_commits_style - Jumlah maksimum komitmen terakhir untuk digunakan untuk gaya. Secara default diatur ke 5 .
  • max_characters (digunakan sebagai properti dalam salah satu aturan default) - jumlah maksimum karakter yang diinginkan dalam pesan komit. Secara default diatur ke 100 .

• Untuk mendapatkan daftar aturan, jalankan perintah berikut:

  painy rules

  • Untuk menambahkan aturan baru jalankan perintah berikut:

    painy rules --add " Your own rule "

  • Untuk menghapus aturan i-th dari daftar jalankan perintah berikut:

    painy rules --remove < i >