A CLI tool for attaching visuals to git commits.
Runs on Windows and Linux (without rigorous testing), may work with macOS.
uv and python>=3.11
.
uv is very fast, it dropped command runtime from 0.5s -> 0.1s. Hence why I am using it over poetry
.
uv will just install the needed packages, but if you would like, see the pyproject.toml
for exacts.
In project root:
uv lock && uv sync
uv build
Now you should have the sdist and wheel in dist/
. If you are using a virtual env, you should run:
python -m venv .venv
source .venv/bin/activate
pip install ./dist/vit-0.1.0-py3-none-any.whl
If you want plug and play, install with --user
as your PATH likely has immediate access to your site-packages
.
python -m pip install --force-reinstall --user ./dist/vit-0.1.0-py3-none-any.whl
You don't need --force-reinstall
on fresh, but if the script updates you should use this.
Just make sure $HOME/.local/bin
or %APPDATA%\Python\...\Scripts
(on Windows) are on your PATH to use this in external repos.
Run vit --help
to see the commands. They are meant to be adjacent to git
commands.
Meant to integrate with existing git repos, so only run vit init
where repositories exist.
This project is licensed under the MIT License. See LICENSE.md for more details.