Skip to main content

Build Status PyPI version

mdformat-beautysh

Mdformat plugin to beautify Bash scripts

Description

mdformat-beautysh is an mdformat plugin that makes mdformat format Bash scripts with Beautysh. Fenced code blocks labeled as either sh or bash are formatted.

Usage

Install with:

pip install mdformat-beautysh

When using mdformat on the command line, Beautysh formatting will be automatically enabled after install.

When using mdformat Python API, code formatting for Bash scripts will have to be enabled explicitly:

import mdformat


unformatted = """```bash
function bad_func()
 {
echo "test"
}
```
"""

formatted = mdformat.text(unformatted, codeformatters={"bash", "sh"})

assert formatted == """```bash
function bad_func()
{
    echo "test"
}
```
"""

Metadata

Release files for mdformat-beautysh 1.0.0

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for mdformat-beautysh 1.0.0
File Size Uploaded
mdformat_beautysh-1.0.0.tar.gz 2.5 kB Details

Built distribution (wheel)

Table of built distributions (wheels) for mdformat-beautysh 1.0.0
File Interpreter ABI Platform
mdformat_beautysh-1.0.0-py3-none-any.whl Python 3 none any Details

Total release size: 5.7 kB

Release files / mdformat_beautysh-1.0.0.tar.gz

Download URL mdformat_beautysh-1.0.0.tar.gz
Size 2.5 kB
Tags Source
SHA-256 checksum
How to use checksums
10bb22859ffed2a433f2b9b30de4faf7fcdebb9f9d95bd39ecbd437c6a3c686e
BLAKE2b-256 checksum
How to use checksums
a3e9f2b37a54442a2e59278b486a6e1b83e6ea140e7ba6bce8392ca9e2b99c5e
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/6.2.0 CPython/3.14.0

Release files / mdformat_beautysh-1.0.0-py3-none-any.whl

Download URL mdformat_beautysh-1.0.0-py3-none-any.whl
Size 3.2 kB
Tags Python 3
SHA-256 checksum
How to use checksums
9209b42e87dd94c44615669b613ea6cf704c6fd25b6ace5a9ce1e0452088faf2
BLAKE2b-256 checksum
How to use checksums
d0ace12f4aef06c7db4b6c35cd513c91ce9461b8f61ae954ef6f8c710135d43e
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/6.2.0 CPython/3.14.0

Release history Release notifications | RSS feed

This release

1.0.0 This release

2 release files

0.1.1

2 release files

0.1.0

2 release files

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page