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

Uploaded Python 3

File details

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

File metadata

  • Download URL: commit_crafter_ai-1.0.2.tar.gz
  • Upload date:
  • Size: 4.2 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.2.tar.gz
Algorithm Hash digest
SHA256 e5aa13e920787d96fceb5acf9fbb4fe575f21651cf3a1e022748a837eb29d3e7
MD5 6cb60a33849d63ae5f2e220ab2f0ee73
BLAKE2b-256 f94b7540856c0662e44c6ccb96e2dd992686d8b00c14b205eb51de1e8118d511

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for commit_crafter_ai-1.0.2-py3-none-any.whl
Algorithm Hash digest
SHA256 d50c0dca11c3fdc16b28f29e4e08ebc8e689e807ef763afc974a01c4a00d238c
MD5 36a1213334180c933712e7f3b669a745
BLAKE2b-256 4bab3ef1cc44a7590fa54639c5246f91f7a2db2731e276d768e9f2c5af9cd213

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