codeowners-cli 0.1.0

Codeowners parser and CLI for Python

codeowners-cli

Python codeowners parser with a CLI — look up file owners from your CODEOWNERS file.

This is a fork of sbdchd/codeowners, which is a Python port of hmarr's Go library and softprops's Rust crate. This fork adds a codeowners-cli entry point installable via uvx, and modernizes the project tooling to use uv, ruff, and ty.

Install

# Run once with uvx
uvx codeowners-cli <filenames>

# Or install persistently
uv tool install codeowners-cli

CLI Usage

# Auto-detects CODEOWNERS in the current git repo
codeowners-cli src/foo.py tests/bar.py

# Explicit path
codeowners-cli --codeowners .github/CODEOWNERS src/foo.py

# Only show files that have owners
codeowners-cli --only-owners src/foo.py src/bar.py

# Structured output
codeowners-cli --output json src/foo.py
codeowners-cli --output csv  src/foo.py
codeowners-cli --output tsv  src/foo.py

# Omit header row
codeowners-cli --no-header src/foo.py

Default text output:

filename        owners
src/foo.py      @alice @team/backend
src/bar.py      [e-mail]

Library Usage

from codeowners import CodeOwners

owners = CodeOwners(open("CODEOWNERS").read())
print(owners.of("src/foo.py"))
# [('USERNAME', '@alice'), ('TEAM', '@team/backend')]

Development

uv sync

# Run tests
uv run pytest

# Lint
uv run ruff check .

# Format
uv run ruff format .

# Type check
uv run ty check