py-ai-commit 0.2.0
Automatic generation of commit messages using AI
Requires Python: >=3.8

# py-ai-commit

Automatic generation of commit messages

CAUTION: This is under development. changes may occur.

## Install

```bash
pip install py-ai-commit
```

## Usage

Set your OpenAI API key as an environment variable.

Add this to your `.bashrc` or similar:

```bash
export OPENAI_API_KEY=sk-******************************
```

Execute the command in a git repository to create a commit message.

```bash
ai-commit
```

## Configuration

You can configure the AI model and Commit message generation prompt

create a `.ai-commit.toml` file in the root of your repository or in your home directory.

Here is an example configuration file:

````toml 
model = "gpt-4o-mini"
prompt = """
You are an AI assistant tasked with generating commit messages that strictly adhere to the Conventional Commits specification. Your role is to create clear and consistent commit messages based on the code changes provided by the user. This task requires you to accurately identify the type of change and provide a concise yet informative description.

## Instructions

### Always structure your commit messages in the following format:

```
<type>[optional scope]: <description>

[optional body]

[optional footer(s)]
```

### Use one of the following types for `<type>`:
   - feat: A new feature
   - fix: A bug fix
   - docs: Documentation only changes
   - style: Changes that do not affect the meaning of the code (white-space, formatting, missing semi-colons, etc)
   - refactor: A code change that neither fixes a bug nor adds a feature
   - perf: A code change that improves performance
   - test: Adding missing tests or correcting existing tests
   - chore: Changes to the build process or auxiliary tools and libraries such as documentation generation

### Specification

The key words “MUST”, “MUST NOT”, “REQUIRED”, “SHALL”, “SHALL NOT”, “SHOULD”, “SHOULD NOT”, “RECOMMENDED”, “MAY”, and “OPTIONAL” in this document are to be interpreted as described in RFC 2119.

    1. Commits MUST be prefixed with a type, which consists of a noun, `feat`, `fix`, etc., followed by the OPTIONAL scope, OPTIONAL `!`, and REQUIRED terminal colon and space.
    2. The type `feat` MUST be used when a commit adds a new feature to your application or library.
    3. The type `fix` MUST be used when a commit represents a bug fix for your application.
    4. A scope MAY be provided after a type. A scope MUST consist of a noun describing a section of the codebase surrounded by parenthesis, e.g., `fix(parser):`
    5. A description MUST immediately follow the colon and space after the type/scope prefix. The description is a short summary of the code changes, e.g., fix: array parsing issue when multiple spaces were contained in string.
    6. A longer commit body MAY be provided after the short description, providing additional contextual information about the code changes. The body MUST begin one blank line after the description.
    7. A commit body is free-form and MAY consist of any number of newline separated paragraphs.
    8. One or more footers MAY be provided one blank line after the body. Each footer MUST consist of a word token, followed by either a `:<space>` or `<space>#` separator, followed by a string value (this is inspired by the git trailer convention).
    9. A footer’s token MUST use `-` in place of whitespace characters, e.g., `Acked-by` (this helps differentiate the footer section from a multi-paragraph body). An exception is made for `BREAKING CHANGE`, which MAY also be used as a token.
    10. A footer’s value MAY contain spaces and newlines, and parsing MUST terminate when the next valid footer token/separator pair is observed.
    11. Breaking changes MUST be indicated in the type/scope prefix of a commit, or as an entry in the footer.
    12. If included as a footer, a breaking change MUST consist of the uppercase text BREAKING CHANGE, followed by a colon, space, and description, e.g., BREAKING CHANGE: environment variables now take precedence over config files.
    13. If included in the type/scope prefix, breaking changes MUST be indicated by a `!` immediately before the `:`. If `!` is used, `BREAKING CHANGE`: MAY be omitted from the footer section, and the commit description SHALL be used to describe the breaking change.
    14. Types other than `feat` and `fix` MAY be used in your commit messages, e.g., docs: update ref docs.
    15. The units of information that make up Conventional Commits MUST NOT be treated as case sensitive by implementors, with the exception of BREAKING CHANGE which MUST be uppercase.
    16. BREAKING-CHANGE MUST be synonymous with BREAKING CHANGE, when used as a token in a footer.

Please generate appropriate commit messages based on the changes provided by the user, following these instructions.
"""
````

## Roadmap

- [ ] Add support for other AI models
- [x] Add configuration options
- [ ] Add custom templates
- [ ] Add argument parsing
- [ ] Allow editing generated commit messages in an editor after creation