Skip to main content

A simple CLI utility for generating formatted text headers with borders and boxes.

Project description

hfmt-cli

A simple CLI utility for generating formatted text headers with borders and boxes.

PyPI version

📦 Requirements

  • Python ≥ 3.9

🛠 Usage

Run with a positional argument:

$ hfmt "project title"
################################## project title ###################################

Run with flags:

$ hfmt --head "build complete" --style multi --char "=" --width 60 --upper --align left
============================================================
= BUILD COMPLETE 
============================================================
$ hfmt --border-only --width 50
##################################################

Run with box mode:

$ hfmt --title --width auto --box double "welcome back"
╔══════════════╗
║ Welcome Back ║
╚══════════════╝

⚙️ Options

hfmt-cli supports the following value flags:

Flag Description Default
head (positional) Header text
-H, --head Header text (alternative flag form)
-s, --style Border style (single, multi) single
-c, --char Character to use for the border #
-w, --width Width of the rows 84 or auto
-a, --align Header justification center or left
-b, --box Surround header by a box (overrides other flags) none

hfmt-cli supports the following value toggles:

Toggle Description
-U, --upper Converts header to "UPPER_CASE"
-L, --lower Converts header to "lower_case"
-T, --title Converts header to "Title_Case"
-S, --swapcase Converts header to "sWAP_cASE"
--border-only Returns only a border of characters with no header

🚀 Installation

Install via pipx

pipx install hfmt-cli

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

hfmt_cli-0.1.2.tar.gz (6.7 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

hfmt_cli-0.1.2-py3-none-any.whl (7.1 kB view details)

Uploaded Python 3

File details

Details for the file hfmt_cli-0.1.2.tar.gz.

File metadata

  • Download URL: hfmt_cli-0.1.2.tar.gz
  • Upload date:
  • Size: 6.7 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.7

File hashes

Hashes for hfmt_cli-0.1.2.tar.gz
Algorithm Hash digest
SHA256 2ce0408c6fefe0b2ee8e064960f24203c74aaf571aa0a359ad1e7c491685e3d2
MD5 7c932f4e091d61e73434581145e53eeb
BLAKE2b-256 25bc554a48d62e74dc430cfbb9cd74beb4cd8831e5e23ad85404de60767774ee

See more details on using hashes here.

Provenance

The following attestation bundles were made for hfmt_cli-0.1.2.tar.gz:

Publisher: python-publish.yml on BogdanPri/hfmt-cli

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file hfmt_cli-0.1.2-py3-none-any.whl.

File metadata

  • Download URL: hfmt_cli-0.1.2-py3-none-any.whl
  • Upload date:
  • Size: 7.1 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.7

File hashes

Hashes for hfmt_cli-0.1.2-py3-none-any.whl
Algorithm Hash digest
SHA256 398bc181b17b105b1a776ab538498e5fb0866380888f02437b55f336738b8f08
MD5 9d04e332ae2c721e6d22a9987f8648e3
BLAKE2b-256 3c15f358a232cdbce6a9102e5dad502a1278d1398b4923a183e7030589bed56b

See more details on using hashes here.

Provenance

The following attestation bundles were made for hfmt_cli-0.1.2-py3-none-any.whl:

Publisher: python-publish.yml on BogdanPri/hfmt-cli

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Supported by

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