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.2.15.38.tar.gz (183.8 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.2.15.38-py3-none-any.whl (26.5 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: framed_text-2026.4.2.15.38.tar.gz
  • Upload date:
  • Size: 183.8 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.2.15.38.tar.gz
Algorithm Hash digest
SHA256 d24a61c86910b9b925b38f6cd94ec3151581138935156f95c17b3d06945b21b1
MD5 ce7dfc2c6e3efcd16219b578414e7826
BLAKE2b-256 93fc8f5c1644b7685636fce432dd6648aaa6e34652566d1c9c7ffb1ad5b1919e

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for framed_text-2026.4.2.15.38-py3-none-any.whl
Algorithm Hash digest
SHA256 be20f286ede248ec3097235ba81c02856740c5e5a6061827602a9edb10f9de35
MD5 7857a8ffa3805ff5e8c15b2ddc123a32
BLAKE2b-256 eb6733a40680cdd0d04817fe1a11b8b9bfae960c26ab5945bf9e78fd54e458d0

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