Metadata-Version: 2.1
Name: hadolint_coatl
Version: 2.12.0.2
Summary: Python wrapper around invoking hadolint (https://github.com/hadolint/hadolint)
Home-page: https://github.com/coatl-dev/hadolint-coatl
Author: César Román
Author-email: cesar@coatl.dev
License: MIT
Project-URL: Funding, https://github.com/sponsors/cesarcoatl
Project-URL: Source, https://github.com/coatl-dev/hadolint-coatl
Project-URL: Tracker, https://github.com/coatl-dev/hadolint-coatl/issues
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3 :: Only
Classifier: Programming Language :: Python :: Implementation :: CPython
Requires-Python: >=3.8
Description-Content-Type: text/markdown
License-File: LICENSE

# hadolint-coatl

[![PyPI - Version](https://img.shields.io/pypi/v/hadolint-coatl)](https://pypi.org/project/hadolint-coatl)
[![Downloads](https://static.pepy.tech/badge/hadolint-coatl)](https://pepy.tech/project/hadolint-coatl)

A python wrapper to provide a pip-installable [hadolint] binary. Inspired by
[shellcheck-py].

Internally this package provides a convenient way to download the pre-built
hadolint binary for your particular platform.

### installation

```bash
pip install hadolint-coatl
```

### usage

After installation, the `hadolint` binary should be available in your
environment (or `hadolint.exe` on windows).

### As a pre-commit hook

See [pre-commit] for instructions

Sample `.pre-commit-config.yaml`:

```yaml
  - repo: https://github.com/coatl-dev/hadolint-coatl
    rev: 2.12.0.2
    hooks:
      - id: hadolint
```

[hadolint]: https://github.com/hadolint/hadolint
[pre-commit]: https://pre-commit.com
[shellcheck-py]: https://github.com/shellcheck-py/shellcheck-py
