A CLI tools and hooks on my shelf for my any Python packages. This project help me to make Versioning, run Abbreviate of Git CLI.
Note
This project was created because I do not want to hard code set up all of them
every time when I start create a new Python package 😫. I provide some
reusable CLIs that was implemented by Click.
pip install -U clishelfIn the future, I will add more the CLI tools that able to dynamic with many style of config such as I want to make changelog file with style B by my custom message code.
Dependency supported:
| Python Version | Installation | Supported |
|---|---|---|
== 3.8 |
pip install "clishelf<=0.1.10" |
❌ |
>=3.9.13,<3.14 |
pip install -U clishelf |
✅ |
Warning
This package already installed pre-commit with the latest version.
See pre-commit for instructions
- repo: https://github.com/korawica/clishelf
rev: v0.2.23
hooks:
- id: shelf-commit-msg
stages: [commit-msg]Example:
Auto add emoji and format commit message before commit.
git commit -am "docs: update readme file"
# ...
# shelf prepare commit message.............................................Passed
# [main dfb229c] :page_facing_up: docs: update readme file. <-- 🎉 SUCCESS 🎉
# 3 files changed, 10 insertions(+), 3 deletions(-)This Utility Package provide some CLI tools for handler development process.
Usage: shelf.exe [OPTIONS] COMMAND [ARGS]...
The Main Shelf commands.
Commands:
conf Return config for clishelf commands
cove Run the coverage command.
dep List of Dependencies that was set in pyproject.toml file.
emoji The Emoji commands
git The Extended Git commands
vs The Versioning commands.
This is abbreviation of Git CLI that warped with the Python subprocess package.
Usage: shelf.exe git [OPTIONS] COMMAND [ARGS]...
The Extended Git commands
Commands:
bn-clear Clear Local Branches that sync from the Remote repository.
cm Prepare and show the latest commit message with the commit...
cm-msg Return list of commit prefixes
cm-prefix Show the commit prefix that setting in current config.
cm-prev Commit changes to the Previous Commit with same message.
cm-revert Revert the latest Commit on the Local repository.
mg Merge change from another branch with strategy, `theirs` or...
tg-bump Create Tag from current version after bumping
tg-clear Clear Local Tags that sync from the Remote repository.
This is the enhancement bump2version Python package for my bumping style.
Usage: shelf.exe vs [OPTIONS] COMMAND [ARGS]...
The Versioning commands.
Commands:
bump Bump package version with a next tag value with an input...
changelog Make a changelog file that generate form previous commits.
current Return Current Version that read from ``__about__`` by default.
This is the emoji CLI that getting data from GitHub dataset.
Usage: shelf.exe emoji [OPTIONS] COMMAND [ARGS]...
The Emoji commands
Commands:
fetch Refresh emoji metadata file on assets folder.
.clishelf.yaml:
version:
version: "./clishelf/__about__.py"
changelog: "CHANGELOG.md"
mode: "normal"pyproject.toml:
[tool.shelf.version]
version = "./clishelf/__about__.py"
changelog = "CHANGELOG.md"
mode = "normal"Important
The bump version mode able to be normal or datetime only.
git:
commit_prefix:
- ["comment", "Documents", ":bulb:"] # 💡
- ["typos", "Documents", ":pencil2:"] # ✏️
commit_prefix_group:
- ["Features", ":tada:"] # 🎉| Module | Key | Default | Description |
|---|---|---|---|
| git | commit_prefix | None |
Commit prefix that want to override/append |
| commit_prefix_group | None |
Commit prefix group that want to override/append | |
| commit_msg_format | "{emoji} {prefix}: {subject}" |
Commit message format that use to prepare | |
| commit_prefix_pre_demojize | True |
Auto de-emoji on a commit log subject | |
| commit_prefix_force_fix | False |
Force fix if commit message does not match with normal form | |
| version | version | "./{PROJECT-NAME}/__about__.py" |
Version tracking file location path (with .py format) |
| changelog | "CHANGELOG.md" |
Changelog file location path | |
| mode | "normal" |
"normal" for normal version"datetime" for datetime time mode (format %Y%m%d.%pre-release) |
|
| commit_subject_format | "{emoji} {prefix}: {subject}" |
Commit subject format that use to writing a changelog file with commit_msg_format
|
|
| commit_msg_format | "- {subject} (_{datetime:%Y-%m-%d}_)" |
Commit message format that use to writing a changelog file |
- (Optional) I will implement use
richandalive-progressto this project for make interface terminal prettier. - (Optional) Dynamic emoji changing for support other platform such as GitLab.
- (BIG) Remove
bump2versionpackage and implement my bump function instead.
Note
I will migrate this code from Python to Rust for performance of this CLI (But I will observe for this again because this package does not have any issue with perf as well).
I do not think this project will go around the world because it has specific propose, and you can create by your coding without this project dependency for long term solution. So, on this time, you can open the GitHub issue on this project 🙌 for fix bug or request new feature if you want it.
![pre-commit-ci[bot]](https://avatars.githubusercontent.com/u/66853113?size=120)
![dependabot[bot]](https://avatars.githubusercontent.com/u/49699333?size=120)
