https://github.com/shellcheck-py/shellcheck-py

python3/pip3 wrapper for installing shellcheck
https://github.com/shellcheck-py/shellcheck-py

Last synced: about 2 months ago
JSON representation

python3/pip3 wrapper for installing shellcheck

• Host: GitHub
• URL: https://github.com/shellcheck-py/shellcheck-py
• Owner: shellcheck-py
• License: mit
• Created: 2019-11-03T18:43:23.000Z (almost 5 years ago)
• Default Branch: main
• Last Pushed: 2024-06-25T18:17:08.000Z (3 months ago)
• Last Synced: 2024-07-18T07:54:52.428Z (2 months ago)
• Language: Python
• Size: 145 KB
• Stars: 150
• Watchers: 6
• Forks: 16
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

• my-awesome-starred - shellcheck-py/shellcheck-py - python3/pip3 wrapper for installing shellcheck (Python)

README

        
[![build status](https://github.com/shellcheck-py/shellcheck-py/actions/workflows/main.yml/badge.svg)](https://github.com/shellcheck-py/shellcheck-py/actions/workflows/main.yml)

[![pre-commit.ci status](https://results.pre-commit.ci/badge/github/shellcheck-py/shellcheck-py/main.svg)](https://results.pre-commit.ci/latest/github/shellcheck-py/shellcheck-py/main)

# shellcheck-py

A python wrapper to provide a pip-installable [shellcheck] binary.

Internally this package provides a convenient way to download the pre-built

shellcheck binary for your particular platform.

### installation

```bash

pip install shellcheck-py

```

### usage

After installation, the `shellcheck` binary should be available in your

environment (or `shellcheck.exe` on windows).

### As a pre-commit hook

See [pre-commit] for instructions

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

```yaml

-   repo: https://github.com/shellcheck-py/shellcheck-py

    rev: v0.10.0.1

    hooks:

    -   id: shellcheck

```

[shellcheck]: https://shellcheck.net

[pre-commit]: https://pre-commit.com