Metadata-Version: 2.4
Name: katana-markdown-linter
Version: 0.18.5
Summary: Fast Markdown linter and formatter with localized CLI help and version aliases.
License-Expression: MIT
Project-URL: Homepage, https://github.com/HiroyukiFuruno/katana-markdown-linter
Project-URL: Repository, https://github.com/HiroyukiFuruno/katana-markdown-linter
Project-URL: Issues, https://github.com/HiroyukiFuruno/katana-markdown-linter/issues
Project-URL: Changelog, https://github.com/HiroyukiFuruno/katana-markdown-linter/blob/main/CHANGELOG.md
Keywords: markdown,markdownlint,linter,cli,kml
Classifier: Development Status :: 4 - Beta
Classifier: Environment :: Console
Classifier: Intended Audience :: Developers
Classifier: Operating System :: MacOS
Classifier: Operating System :: Microsoft :: Windows
Classifier: Operating System :: POSIX :: Linux
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: 3.13
Classifier: Topic :: Software Development :: Quality Assurance
Classifier: Topic :: Text Processing :: Markup :: Markdown
Requires-Python: >=3.11
Description-Content-Type: text/markdown

# katana-markdown-linter Python wrapper

`katana-markdown-linter` is a thin Python launcher for the `kml` Markdown
linter. The package does not contain independent lint logic. On first use, it
downloads the matching `kml` binary archive from GitHub Releases, verifies the
neighboring SHA-256 checksum, installs the binary into the wrapper cache, and
then delegates all commands to that binary, including localized CLI help.

## Install

~~~bash
pipx install katana-markdown-linter
kml --version
~~~

Use `uvx` for one-off runs:

~~~bash
uvx --from katana-markdown-linter==0.18.0 kml --version
uvx --from katana-markdown-linter==0.18.0 kml check README.md
~~~

## Basic Usage

~~~bash
# Run linting
kml check README.md

# Show help
kml help
kml --help
kml -h
kml check --help

# Localized help
kml --locale ja help

# Show version aliases
kml version
kml --version
kml -v

# Fix and Format
kml fix README.md
kml fmt
~~~

## Supported Platforms

The Python launcher uses the same binary archives as the GitHub Release
channel. It currently supports:

- macOS arm64: `aarch64-apple-darwin`
- macOS x64: `x86_64-apple-darwin`
- Linux x64: `x86_64-unknown-linux-gnu`
- Windows x64: `x86_64-pc-windows-msvc`

Unsupported platforms fail before download with an explicit platform error.

## Wrapper Contract

- The package version selects the GitHub Release tag.
- The launcher downloads `kml-vX.Y.Z-<target>.tar.gz` or
  `kml-vX.Y.Z-<target>.zip`.
- The launcher downloads the matching `.sha256` file and verifies the archive
  before extraction.
- The installed binary is cached under the package-local `vendor` directory by
  default.

For full CLI usage, rule coverage, and other install channels, see the
[repository README](https://github.com/HiroyukiFuruno/katana-markdown-linter).
Report package issues through
[GitHub Issues](https://github.com/HiroyukiFuruno/katana-markdown-linter/issues).
