This is the CLI on my shelf (Tools and Hooks) for any my Python packages
that help me to make Versioning, run Abbreviate of Git CLI, and Wrapped Dev Python
packages (more-itertools, pre-commit, ...) on my any Python package
repositories.
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 from Click.
pip install 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 | Support Fixed Bug |
|---|---|---|
== 3.8 |
pip install "clishelf>=0.1.10,<0.2.8" |
❌ |
>=3.9.13,<3.13 |
pip install -U clishelf |
✔️ |
See pre-commit for instructions
- repo: https://github.com/korawica/clishelf
rev: v0.2.8
hooks:
- id: shelf-commit-msg
stages: [commit-msg]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-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`...
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:"] # 🎉- I will implement use
richandalive-progressto this project for make interface terminal prettier. - Dynamic emoji changing for support other platform such as GitLab.
- (BIG) Remove
bump2versionpackage and implement the own bump function.
Note
I will migrate this code from Python to Rust for performance of CLI (But I will observe for this again because this package does not have any issue with perf as well.)