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 craft

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.3.tar.gz (3.3 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.3-py3-none-any.whl (3.8 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: commit_crafter_ai-1.0.3.tar.gz
  • Upload date:
  • Size: 3.3 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.3.tar.gz
Algorithm Hash digest
SHA256 2e2319b85d9869da521954ae5af17650df157d951db0ca0a901d298f85ae7d9c
MD5 9d5f8a9c521677a603073e8c8c4bee54
BLAKE2b-256 a02d1a63ae252d359a481f83c2f018476b820b36fc75f6677b9ffa615d19e7c4

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for commit_crafter_ai-1.0.3-py3-none-any.whl
Algorithm Hash digest
SHA256 8fda11bfa7c3420b4db78896303ade58b623ffa908208af936720b8e2e6bc90e
MD5 8f99440ca83ec935f20aea91b83d7b90
BLAKE2b-256 fb224fa5df76a29533a0585d1977d643aa3e022cd2a52a920fb2e5f0ddcd45e5

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