kislyuk / katalin

A GitHub action that generates LLM-assisted suggestions for improving Python code in PRs

katalin GitHub action

This is a GitHub action that generates LLM-assisted suggestions for improving Python code in PRs, and posts them as PR comments.

See this sample PR for an example of katalin in action.

Inputs

openai-api-token

Required The OpenAI API token to use.

enabled-advisors

A newline-separated list of advisor modules to enable. Available advisors are:

• docstrings: Provides doscstring suggestions for undocumented Python modules, functions, classes, and methods.
• security: Provides comments regarding potential security concerns.
• logic-check: Identifies possible logic errors.

Example usage

uses: kislyuk/katalin@v1
with:
  openai-api-key: ${{secrets.OPENAI_API_KEY}}
  enabled-advisors: |-
    docstrings
    security
    logic-check

See Using secrets in GitHub Actions for details on how to set the secret above.