dbrownell-CommitEmojis 0.1.3

Tools that enhance the gitmoji (https://gitmoji.dev/) experience.

Project:

Package:

Development:

Contents

• Overview
• Installation
• Development
• Additional Information
• License

Overview

dbrownell_CommitEmojis offers command line tools useful when creating git commit messages based on gitmoji.

How to use dbrownell_CommitEmojis

Display

Scenario	Command
Without installation	uvx --from dbrownell_CommitEmojis commit_emojis Display
When installed as a package dependency	uv run commit_emojis Display

Transform

Scenario	Command
Without installation	uvx --from dbrownell_CommitEmojis commit_emojis Transform <commit message>
When installed as a package dependency	uv run commit_emojis Transform <commit message>

Examples for <commit message> are:

Input	Output
:+project: Initial checkin	🎉 [+project] Initial checkin
:+feature: A new feature was added	✨ [+feature] A new feature was added

See Display for a list of all supported emoji and alias values.

Installation

Installation Method	Command
Via uv	uv add dbrownell_CommitEmojis
Via pip	pip install dbrownell_CommitEmojis

Verifying Signed Artifacts

Artifacts are signed and validated using py-minisign and the public key in the file ./minisign_key.pub.

To verify that an artifact is valid, visit the latest release and download the .minisign signature file that corresponds to the artifact, then run the following command, replacing <filename> with the name of the artifact to be verified:

uv run --with py-minisign python -c "import minisign; minisign.PublicKey.from_file('minisign_key.pub').verify_file('<filename>')"

Development

Please visit Contributing and Development for information on contributing to this project.

Additional Information

Additional information can be found at these locations.

Title	Document	Description
Code of Conduct	CODE_OF_CONDUCT.md	Information about the norms, rules, and responsibilities we adhere to when participating in this open source community.
Contributing	CONTRIBUTING.md	Information about contributing to this project.
Development	DEVELOPMENT.md	Information about development activities involved in making changes to this project.
Governance	GOVERNANCE.md	Information about how this project is governed.
Maintainers	MAINTAINERS.md	Information about individuals who maintain this project.
Security	SECURITY.md	Information about how to privately report security issues associated with this project.

License

dbrownell_CommitEmojis is licensed under the MIT license.