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.3.14.45.tar.gz (222.7 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.3.14.45-py3-none-any.whl (28.5 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: framed_text-2026.5.3.14.45.tar.gz
  • Upload date:
  • Size: 222.7 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.3.14.45.tar.gz
Algorithm Hash digest
SHA256 42280357841dd3619f984bf5f0f58c1018d9c0c5787f3c0120a64a102039a3f8
MD5 ea86ac121f0e5e93abdf951bf25713b6
BLAKE2b-256 d2c8d8b78c8d354fe13835e7639731cbc58bd466b58aa1ee849a53869f55066d

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for framed_text-2026.5.3.14.45-py3-none-any.whl
Algorithm Hash digest
SHA256 32e7e4a29c5468b532acdd8b6df2ff04c6be3e16f7f764577e72a1b23f34dab2
MD5 aebadad3af1c61090efd179c39b08534
BLAKE2b-256 f1a82f67b2f2abcb32ce61e891aaaa58073423bf4e931209be918b99e6b307a2

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