shfmt-py

Name	shfmt-py JSON
Version	3.7.0.1 JSON
	download
home_page	https://github.com/maxwinterstein/shfmt-py
Summary	Python wrapper around invoking shfmt (https://github.com/mvdan/sh)
upload_time	2023-08-20 21:13:39
maintainer
docs_url	None
author	Max Winterstein
requires_python	>=3.8
license	MIT
keywords
VCS
bugtrack_url
requirements	No requirements were recorded.
Travis-CI	No Travis.
coveralls test coverage	No coveralls.

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

# 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

```bash
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`:

```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][here1] or [here][here2] for

[shfmt]: https://github.com/mvdan/sh
[pre-commit]: https://pre-commit.com
[shellcheck-py]: https://github.com/shellcheck-py/shellcheck-py
[here1]: https://github.com/albertogeniola/MerossIot/issues/62#issuecomment-535769621
[here2]: https://stackoverflow.com/questions/27835619/urllib-and-ssl-certificate-verify-failed-error

            

Raw data

            {
    "_id": null,
    "home_page": "https://github.com/maxwinterstein/shfmt-py",
    "name": "shfmt-py",
    "maintainer": "",
    "docs_url": null,
    "requires_python": ">=3.8",
    "maintainer_email": "",
    "keywords": "",
    "author": "Max Winterstein",
    "author_email": "github@winterstein.io",
    "download_url": "https://files.pythonhosted.org/packages/8a/26/4d44df44a94e7ea35e85a1e64c41f0ee165eeb763e1f709b173c1f031daf/shfmt_py-3.7.0.1.tar.gz",
    "platform": null,
    "description": "[![pre-commit.ci status](https://results.pre-commit.ci/badge/github/MaxWinterstein/shfmt-py/master.svg)](https://results.pre-commit.ci/latest/github/MaxWinterstein/shfmt-py/master)\n\n# shfmt-py\n\nA python wrapper to provide a pip-installable [shfmt] binary.\n\nInternally this package provides a convenient way to download the pre-built\nshellcheck binary for your particular platform.\n\nThis package is totally cloned from [shellcheck-py] and modified to provide `shfmt` instead.\n\n## Installation\n\n```bash\npip install shfmt-py\n```\n\n## Usage\n\n### CLI\n\nAfter installation, the `shfmt` binary should be available in your\nenvironment (or `shfmt.exe` on windows).\n\n### As pre-commit hook\n\nSee [pre-commit] for instructions\n\nSample `.pre-commit-config.yaml`:\n\n```yaml\n- repo: https://github.com/maxwinterstein/shfmt-py\n  rev: v3.4.3.1\n  hooks:\n    - id: shfmt\n```\n\n## FAQ\n\nQ: I get something like `SSL: CERTIFICATE_VERIFY_FAILED` on macOS\nA: Install certificates with e.g.: `\"/Applications/Python 3.9/Install Certificates.command\"`. See [here][here1] or [here][here2] for\n\n[shfmt]: https://github.com/mvdan/sh\n[pre-commit]: https://pre-commit.com\n[shellcheck-py]: https://github.com/shellcheck-py/shellcheck-py\n[here1]: https://github.com/albertogeniola/MerossIot/issues/62#issuecomment-535769621\n[here2]: https://stackoverflow.com/questions/27835619/urllib-and-ssl-certificate-verify-failed-error\n",
    "bugtrack_url": null,
    "license": "MIT",
    "summary": "Python wrapper around invoking shfmt (https://github.com/mvdan/sh)",
    "version": "3.7.0.1",
    "project_urls": {
        "Homepage": "https://github.com/maxwinterstein/shfmt-py"
    },
    "split_keywords": [],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "8a264d44df44a94e7ea35e85a1e64c41f0ee165eeb763e1f709b173c1f031daf",
                "md5": "5a9750a246b07c4c6251a5bc1c1a67d3",
                "sha256": "119403c9325e9853e2e5b9b75b12bd1d35baf4f22dbc4795a459c9152ea2d9d2"
            },
            "downloads": -1,
            "filename": "shfmt_py-3.7.0.1.tar.gz",
            "has_sig": false,
            "md5_digest": "5a9750a246b07c4c6251a5bc1c1a67d3",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.8",
            "size": 4358,
            "upload_time": "2023-08-20T21:13:39",
            "upload_time_iso_8601": "2023-08-20T21:13:39.889633Z",
            "url": "https://files.pythonhosted.org/packages/8a/26/4d44df44a94e7ea35e85a1e64c41f0ee165eeb763e1f709b173c1f031daf/shfmt_py-3.7.0.1.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2023-08-20 21:13:39",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "maxwinterstein",
    "github_project": "shfmt-py",
    "travis_ci": false,
    "coveralls": false,
    "github_actions": true,
    "tox": true,
    "lcname": "shfmt-py"
}