Skip to main content

Utility for creating framed text in the terminal

Project description

framed_text

framed_text is a Python library for creating framed text with customizable frames and colors.

Full documentation can be found on ReadTheDocs

Features

  • Display text output surrounded by a frame
  • Customize the frame with different colors
  • Optional title that can be colored and styled
  • Status: Print text with a status icon preceeding it
  • LabeledData: A string that consists of a label with different types of data following it
    • Both LabeledData and Status objects can be customized
  • A version of framed text, but just for a title (or divider)

Installation

framed_text can be installed from PyPI using pip:

pip install framed-text

Then import the necessary modules:

# Main classes. See documentation for more details
from framed_text import FramedText, FramedHeader, LabeledData, Status

Additionally, the following objects are available to be imported:

  • framed_text.AnyLabeledData
  • framed_text.AnyStatus
  • framed_text.InvalidColorError
  • framed_text.BaseStatus

Quickstart

The Quick-Start Guide can be found on ReadTheDocs

Credits

Thank you to the following:

  • prompt_toolkit: Main inspiration for making FramedText as well as the source for the ASCII characters.
  • termcolor: Most of the coloring is done by this package. Huge thanks to the devs for this amazing package!
  • Sphinx: Used for building the documentation.
  • ReadTheDocs: Used for hosting the documentation.

License

Copyright (C) 2026  AstroLightz

This program is free software: you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation, either version 3 of the License, or
(at your option) any later version.

This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
GNU General Public License for more details.

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

framed_text-2026.5.9.14.45.tar.gz (952.1 kB view details)

Uploaded Source

Built Distribution

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

framed_text-2026.5.9.14.45-py3-none-any.whl (33.5 kB view details)

Uploaded Python 3

File details

Details for the file framed_text-2026.5.9.14.45.tar.gz.

File metadata

  • Download URL: framed_text-2026.5.9.14.45.tar.gz
  • Upload date:
  • Size: 952.1 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.14.4

File hashes

Hashes for framed_text-2026.5.9.14.45.tar.gz
Algorithm Hash digest
SHA256 d7f7d97247b06a610d9398841297d27a2f4d777f0165d68bc65b725392e58007
MD5 9f47195b59f6aaa4790ef7b274a8e6bc
BLAKE2b-256 f2af240846334775b3ee1aef64ba018128b8e9ae30a28f4d12fa6c0bd62f1c93

See more details on using hashes here.

File details

Details for the file framed_text-2026.5.9.14.45-py3-none-any.whl.

File metadata

File hashes

Hashes for framed_text-2026.5.9.14.45-py3-none-any.whl
Algorithm Hash digest
SHA256 313cbe6d416dd2ad4daa34fc3b15795f41de38f5e6aac39d46cfd32fe680d965
MD5 ace12018e884e95bf648eaf253a7c3f4
BLAKE2b-256 0bb3d9819cda60a65fbacb1232712afa4839f25d3e690f9221d87b800721f021

See more details on using hashes here.

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