git-omit

简体中文

Small Git helpers for files that should only be ignored locally.

Installation

Install the native command from PyPI:

uv tool install git-omit

Or install it into a Python environment:

pip install git-omit

The environment installation supports both entry styles:

git-omit --help
python -m git_omit --help

Prebuilt wheels are published for Windows x86_64, macOS x86_64 and ARM64, and glibc-based Linux x86_64 and ARM64.

Commands

Quote glob patterns so the shell passes them to git-omit unchanged:

git-omit hide '*.log'

Development

To build the project, install Zig 0.17.0 and uv.

uv sync
uv run git-omit --help

Build and run tests locally:

zig build test
zig build -Doptimize=ReleaseSmall

Build all five platform wheels into dist/ with Zig cross-compilation:

uv run python make_wheels.py

Pass --target to build a specific target. Only wheels are built; no source distribution (sdist) is produced.

Windows cross-build note: When building Linux or macOS wheels on Windows, make_wheels.py records mode 0755 in the wheel metadata because Windows chmod cannot set Unix executable bits.

Publish

Before publishing, set UV_PUBLISH_TOKEN, make sure the version matches in pyproject.toml and build.zig.zon, and commit all changes. Then run:

uv run python pypi_publish.py 0.0.4

The script checks the versions, working tree, and local and remote tags, then builds and validates all five wheels. It publishes to PyPI first, then creates and pushes the version tag.