Skip to main content

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)
  • Shorten text to fit on a single line
  • Display progress bars and spinners

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 (
    Color,
    FramedHeader,
    FramedText,
    LabeledData,
    ProgressBar,
    ShortenText,
    Spinner,
    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.

Metadata

Release files for framed-text 2026.6.24.15.15

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

Source distribution (sdist)

Source distribution for framed-text 2026.6.24.15.15
File Size Uploaded
framed_text-2026.6.24.15.15.tar.gz 1.1 MB Details

Built distribution (wheel)

Table of built distributions (wheels) for framed-text 2026.6.24.15.15
File Interpreter ABI Platform
framed_text-2026.6.24.15.15-py3-none-any.whl Python 3 none any Details

Total release size: 1.1 MB

Release files / framed_text-2026.6.24.15.15.tar.gz

Download URL framed_text-2026.6.24.15.15.tar.gz
Size 1.1 MB
Tags Source
SHA-256 checksum
How to use checksums
d65c839c9de0904c08cb619989412e317b4cf0bfad728cf7eb2c75b9919c145f
BLAKE2b-256 checksum
How to use checksums
fa5b1b7f821b04c3c0c5c12c4a6819172a20f3cd14716275db8b19e29edd649b
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/6.2.0 CPython/3.14.6

Release files / framed_text-2026.6.24.15.15-py3-none-any.whl

Download URL framed_text-2026.6.24.15.15-py3-none-any.whl
Size 45.3 kB
Tags Python 3
SHA-256 checksum
How to use checksums
1f0fe93f486bf1b67f74e1c32ae1106c145916f531802e6ab4ec8ef61ef476f1
BLAKE2b-256 checksum
How to use checksums
6502923b1d7bc5d20361ab1273a7423684b46d982121997376176d308bbbdf54
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/6.2.0 CPython/3.14.6
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