A set of utilities for running and logging shell commands in a user-friendly manner.
Project description
klingon_utils
Utility Repository
This repository contains a set of utilities that are frequently used. These utilities are designed to automate and simplify various tasks, making them more efficient and less error-prone.
Contents
Currently, the repository includes the following utilities:
treetool (tt)
: A tool for saving and generating project file and directory structures. See treetool/README.md for more details.gitignore
: A generic .gitignore file. See gitignore/README.md for more details.amnesia
: A utility for rewriting commit history in a Git repository. See amnesia/README.md for more details.Cxcel
: Render CSV files in both terminal and web interfaces. Real-time updates to the displayed CSV content by monitoring file changes. See Cxcel/README.md for more details.klingon tool (kt)
: Installer/updater for klingon tools CLI. See kt/README.md for more details.
klingon_tools
A Python library that contains the following utilities:
logtools
: A utility for running and logging shell commands and their exit codes in a user-friendly manner.
Usage
Each utility has its own specific usage instructions, which can be found in the comments of the utility's script. In general, utilities can be run from the command line and accept various command-line arguments.
Example Usage of gh-actions-update
The gh-actions-update
entrypoint finds all GitHub Actions in the current repository, checks the version they are using, and retrieves the most recent version of each action. It returns a table containing "Action Name", "Current Version", and "Latest Version" columns.
Usage
To use the gh-actions-update
entrypoint, run the following command:
python -m klingon_tools.gh_actions_update
To update all outdated actions to the latest version, use the --update
flag:
python -m klingon_tools.gh_actions_update --update
To update actions in a specific file (bash wildcards accepted), use the --file
flag:
python -m klingon_tools.gh_actions_update --update --file {filename}
To update all instances of a specific action, use the --action
flag:
python -m klingon_tools.gh_actions_update --update --action {action name}
To update all instances of a specific action in a specific file, use both --file
and --action
flags:
python -m klingon_tools.gh_actions_update --update --file {filename} --action {action name}
Example Output
Action Name Current Version Latest Version
------------------- ----------------- ---------------
actions/checkout v2 v3
actions/setup-python v1 v2
Note: Use '--update' to update all outdated actions to the latest version.
Use '--update --file {filename}' to update a specific file (bash wildcards accepted).
Use '--action {action name}' to update all instances of a specific action.
Use '--action' and '--file' together to update all instances of a specific action in a specific file.
Example Usage of logtools
The logtools
utility provides decorators for methods and CLI commands that log output in a clean and consistent manner with simple error handling.
Method State Example
from klingon_tools import LogTools
log_tools = LogTools(debug=True)
@log_tools.method_state(name="Install numpy")
def install_numpy():
return "PIP_ROOT_USER_ACTION=ignore pip install -q numpy"
install_numpy()
Expected output:
Running Install numpy... OK
Command State Example
from klingon_tools import LogTools
commands = [
("PIP_ROOT_USER_ACTION=ignore pip install -q numpy", "Install numpy"),
("echo 'Hello, World!'", "Print Hello World")
]
log_tools.command_state(commands)
Expected output:
Running Install numpy... OK
Conventional Commits
We require all commit messages to follow the Conventional Commits standard. Below are the types we use and their explanations:
Type | Emoticon | Description |
---|---|---|
feat | ✨ | add new user authentication feature |
fix | 🐛 | resolve issue with user login |
docs | 📚 | update README with new setup instructions |
style | 💄 | improve button styling |
refactor | ♻️ | reorganize project structure |
perf | 🚀 | optimize database queries for faster response |
test | 🚨 | add unit tests for login component |
build | 🛠️ | update dependencies |
ci | ⚙️ | add GitHub Actions workflow |
chore | 🔧 | clean up old files |
revert | ⏪ | undo previous commit that caused issues |
Contributing
Contributions are welcome. Please open an issue to discuss your idea before making a change.
License
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
Hashes for klingon_tools-1.0.0rc1-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 25bcbd07ab9cc650928cf0fadd0358a5d335d58d335a1e8519fbcac48e619213 |
|
MD5 | 6a56c14db2f4ee7a98984afefe2ef916 |
|
BLAKE2b-256 | c235a7686f7b59db059f9abe40b9d99eddbd00f2d60b0a284900ce4cbe2e7337 |