Skip to main content

A CLI tool to create Conventional Commits with emoji and scope selection.

Project description

py-commiter

A command-line tool to generate commit messages following the Conventional Commits standard, with support for types, scopes, and Gitmoji emojis.


🌟 Features

  • Interactive selection of commit types (feat, fix, docs, etc.)
  • Support for custom scopes
  • Inclusion of Gitmoji emojis
  • Multiline input with advanced editing (prompt-toolkit)
  • Message rendering inside an ASCII box
  • Git integration: checks git status, allows git add ., and performs final commit

⚙️ Installation

pip install py-commiter

⚡ Quick usage

py-commiter

Follow the step-by-step prompts to build your commit message.


🎨 Example commit message

✨ feat(auth): add login endpoint

Added support for JWT authentication and login error handling.

✏️ License

MIT License. Made with ❤️ by Matias Tillerias Ley.

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

py_commiter-0.1.0.tar.gz (6.8 kB view details)

Uploaded Source

Built Distribution

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

py_commiter-0.1.0-py3-none-any.whl (7.8 kB view details)

Uploaded Python 3

File details

Details for the file py_commiter-0.1.0.tar.gz.

File metadata

  • Download URL: py_commiter-0.1.0.tar.gz
  • Upload date:
  • Size: 6.8 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.12.3

File hashes

Hashes for py_commiter-0.1.0.tar.gz
Algorithm Hash digest
SHA256 72f819f5c5e8b3d8ea2303d5768356a0a9d35ced386c955ea457343a0c71ce48
MD5 36d2d16278261c51d3a6a89c6ea70281
BLAKE2b-256 2e804dffa7471ce9136f64b4694777912d1277eaac2ce3ed13346e064a8dbb8e

See more details on using hashes here.

File details

Details for the file py_commiter-0.1.0-py3-none-any.whl.

File metadata

  • Download URL: py_commiter-0.1.0-py3-none-any.whl
  • Upload date:
  • Size: 7.8 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.12.3

File hashes

Hashes for py_commiter-0.1.0-py3-none-any.whl
Algorithm Hash digest
SHA256 9044d7ef08cbc0e7983a04033ceaf74eaa612a28ce7751188033814e6f2f0fdd
MD5 75f58e671bf685aab6a3b2690d27b164
BLAKE2b-256 ec5a9c41315f7023aa56dac2fadfb9c268c98d3b2bdee3088d4340fc8c6d3169

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