Skip to main content

Python wrapper around invoking shfmt (https://github.com/mvdan/sh)

Project description

pre-commit.ci status

shfmt-py

A python wrapper to provide a pip-installable shfmt binary.

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

This package is totally cloned from shellcheck-py and modified to provide shfmt instead.

Installation

pip install shfmt-py

Usage

CLI

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

As pre-commit hook

See pre-commit for instructions

Sample .pre-commit-config.yaml:

- repo: https://github.com/maxwinterstein/shfmt-py
  rev: v3.4.3.1
  hooks:
    - id: shfmt

FAQ

Q: I get something like SSL: CERTIFICATE_VERIFY_FAILED on macOS A: Install certificates with e.g.: "/Applications/Python 3.9/Install Certificates.command". See here or here for

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

shfmt_py-3.7.0.1.tar.gz (4.4 kB view hashes)

Uploaded Source

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page