Metadata-Version: 2.2
Name: godolint_coatl
Version: 1.0.3
Summary: Python wrapper around invoking godolint (https://github.com/zabio3/godolint)
Home-page: https://github.com/coatl-dev/godolint-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/godolint-coatl
Project-URL: Tracker, https://github.com/coatl-dev/godolint-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

# godolint-coatl

[![GitHub Release](https://img.shields.io/github/v/release/coatl-dev/godolint-coatl)](https://github.com/coatl-dev/godolint-coatl/releases/latest)
[![Downloads](https://static.pepy.tech/badge/godolint-coatl)](https://pepy.tech/project/godolint-coatl)

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

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

## Installation

```bash
pip install godolint-coatl
```

## Usage

After installation, the `godolint` binary should be available in your
environment (or `godolint.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/godolint-coatl
    rev: 1.0.3
    hooks:
      - id: godolint
```

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