😍 Command line tool for enabling pretty emoji commits
Project description
lipsgit
💄 A command line tool for enabling pretty emoji commits
🤖 Automatically add emojis to your commits with semantic matching
⚙️ Fully customise emoji mappings to suit your team
🚀 Getting Started
🛠️ Installation
Use pip
to install lipsgit:
pip install lipsgit
To optimally set up lipsgit, follow the Getting Started guide in the documentation.
🧑💻 Usage
The documentation for lipsgit is available at lipsgit.docs.joss.dev and contains a detailed guide on how to use lipsgit.
To list available commands, either run lipsgit
with no parameters or execute lipsgit
help:
The base command for the lipsgit
CLI.
Subcommands
Name | Description |
---|---|
add | Add a custom emoji entry to lipsgit |
commit | Interactively commit with an emoji |
hook | Run lipsgit as part of a commit_message hook |
init | Initialize lipsgit configuration |
🤝 Contributing
We're excited that you want to contribute to lipsgit. Your help and contributions are greatly appreciated! Read the contribution guidelines to get started.
📜 Code of Conduct
We value your contribution and participation in our community. To ensure a positive and inclusive environment for all, we have established a Code of Conduct. Read the Code of Conduct to learn more.
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
File details
Details for the file lipsgit-0.1.2.tar.gz
.
File metadata
- Download URL: lipsgit-0.1.2.tar.gz
- Upload date:
- Size: 8.4 kB
- Tags: Source
- Uploaded using Trusted Publishing? Yes
- Uploaded via: twine/4.0.2 CPython/3.11.7
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | 2a0b3168ced57d40fbd900460d69c8e4aba5869c8e8eca14c0ba2fdeb21160a4 |
|
MD5 | 00cf3f729ee7b3c1c0fa4f5642162ebc |
|
BLAKE2b-256 | ed33e777ce8be0849a85e599fb560d2a5fac9b417933d8e731c3ca8c5fbfefaf |
File details
Details for the file lipsgit-0.1.2-py3-none-any.whl
.
File metadata
- Download URL: lipsgit-0.1.2-py3-none-any.whl
- Upload date:
- Size: 9.5 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? Yes
- Uploaded via: twine/4.0.2 CPython/3.11.7
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | fb29d075b1649a23874c2af2ec1bb32eb84a7e08f2d244a18860adbc67397171 |
|
MD5 | 2cb47e34ce509d9e77bd08b17d6ec1a8 |
|
BLAKE2b-256 | 18110be91509dcf4eb995c77070c91d43ed2596714d30b806305f299298d41e0 |