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

Uploaded Python 3

File details

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

File metadata

  • Download URL: framed_text-2026.4.2.tar.gz
  • Upload date:
  • Size: 183.6 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.tar.gz
Algorithm Hash digest
SHA256 0a9073e9e58350956eddb7c8647143658188d2a02202cc323267064e11b0ceaa
MD5 2c0f692bd9b7d9a84644193f5bad66ed
BLAKE2b-256 7b4a130b787fe826f10a7e24718e8b052d8a7f43a97f7a9116431b2525cd2296

See more details on using hashes here.

File details

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

File metadata

  • Download URL: framed_text-2026.4.2-py3-none-any.whl
  • Upload date:
  • Size: 26.3 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.14.3

File hashes

Hashes for framed_text-2026.4.2-py3-none-any.whl
Algorithm Hash digest
SHA256 a347a3e59e67da890ac47933bbbe07594860480d417ff42c0a5e00e88aed64f8
MD5 9dbefbea10a721c95a966667a4c6283d
BLAKE2b-256 e7fe04b4a23bef784df0b84d4033f6e0fc3476336eafeb961e52f16d1691b681

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