Metadata-Version: 2.5
Name: zendev-commit
Version: 0.4.0
Summary: Commit-message conventions and interactive commit workflows
Project-URL: Documentation, https://docs.zendev.zrr.dev/
Project-URL: Homepage, https://github.com/zendev-lab/zendev
Project-URL: Issues, https://github.com/zendev-lab/zendev/issues
Project-URL: Repository, https://github.com/zendev-lab/zendev
License-Expression: MIT
Requires-Python: >=3.12
Requires-Dist: questionary>=2.1
Requires-Dist: typer>=0.27
Description-Content-Type: text/markdown

# zendev-commit

`zendev-commit` owns commit profiles, Conventional Commits and Gitmoji
validation, the interactive commit flow, and its vendored data. It can be
installed without the complete `zendev` toolkit.

```shell
uv add --dev zendev-commit
uvx zendev-commit --help
```

```python
from zendev.commit import CommitProfile, validate_commit_message

result = validate_commit_message(
    "feat(parser): accept empty input",
    profile=CommitProfile.CONVENTIONAL,
)
assert result.valid
```

Read the official [Commits guide](https://docs.zendev.zrr.dev/guides/commits/),
[Configuration reference](https://docs.zendev.zrr.dev/reference/configuration/),
and [hook integration](https://docs.zendev.zrr.dev/integrations/prek/)
for profiles, commands, and repository setup.

The vendored Gitmoji catalog and its retained license live under
`src/zendev/data/`. Maintainers should follow the repository contributor guide
when refreshing that data.
