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:

  • 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.4.3.16.0.tar.gz (184.4 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.4.3.16.0-py3-none-any.whl (26.9 kB view details)

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for framed_text-2026.4.3.16.0.tar.gz
Algorithm Hash digest
SHA256 dccd5b970a05907969e1ad0b81b34fe44c6b83f1adba54651fb717a54950f510
MD5 32a7a6ce7ad8f0524622be3eb1036f37
BLAKE2b-256 c0fc1be3cef756c747302f5a82fc5f6772d6f0fcfd0340c982ae1800ef39ae1a

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for framed_text-2026.4.3.16.0-py3-none-any.whl
Algorithm Hash digest
SHA256 2167f43b92718899b3fd5f9426d9826dbd06a0aa706441fcbf5cb8aae3f6e9dc
MD5 8f9d54cb2db772c4c955525f8217d7f2
BLAKE2b-256 f9a0aeb19565f78f43c9a8b8aaa28e335ea5170fbc07262195b8d5ad3ac4bc71

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