Skip to main content

AI-powered commit message generator

Project description

commit-crafter-ai

Ai tool to craft commit from terminal.

Installation

pip install commit-crafter-ai

Usage

commit-crafter-ai

License

This project is licensed under the MIT License - see the LICENSE file for details.

Features

  • Generates clear and concise commit messages
  • Follows conventional commit format
  • Provides detailed descriptions of changes
  • Easy to use command-line interface

Requirements

  • Python 3.7+
  • OpenAI API key

Upload to PyPI

python -m twine upload dist/*

Setup

  1. Export your OpenAI API key:
# Linux/macOS
export OPENAI_API_KEY="your-api-key-here"

# Windows (Command Prompt)
set OPENAI_API_KEY=your-api-key-here

# Windows (PowerShell)
$env:OPENAI_API_KEY="your-api-key-here"
  1. The API key can also be added to your shell configuration file (~/.bashrc, ~/.zshrc, etc.) for persistence:
echo 'export OPENAI_API_KEY="your-api-key-here"' >> ~/.bashrc  # or ~/.zshrc

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

commit_crafter_ai-1.0.1.tar.gz (4.1 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

commit_crafter_ai-1.0.1-py3-none-any.whl (4.2 kB view details)

Uploaded Python 3

File details

Details for the file commit_crafter_ai-1.0.1.tar.gz.

File metadata

  • Download URL: commit_crafter_ai-1.0.1.tar.gz
  • Upload date:
  • Size: 4.1 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.0.1 CPython/3.12.2

File hashes

Hashes for commit_crafter_ai-1.0.1.tar.gz
Algorithm Hash digest
SHA256 35a1c1faa661ba1986a193195bfa5edae280f2eb067df03e863389e2d5847024
MD5 1070bb16e8d55244347840e58c16813d
BLAKE2b-256 0d827647107c4215bcedd3ba24a0223b62e4ec7656486d87c27916fa5bd48654

See more details on using hashes here.

File details

Details for the file commit_crafter_ai-1.0.1-py3-none-any.whl.

File metadata

File hashes

Hashes for commit_crafter_ai-1.0.1-py3-none-any.whl
Algorithm Hash digest
SHA256 8513ea262ebb62784d78f1c829b24a8333642f6853ac2509890a289ce28a547a
MD5 cff87a5f8f10939da666cc2d8b8c5e0b
BLAKE2b-256 f00c7f7aa3e9ad55847b1b554562ed20216f6b37310ab34e9c75cc371cb5495a

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page