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

Uploaded Python 3

File details

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

File metadata

  • Download URL: framed_text-2026.3.31.tar.gz
  • Upload date:
  • Size: 183.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.3.31.tar.gz
Algorithm Hash digest
SHA256 ddd65a065214f3179d443e10609f9eb0b92c31ae2528ead6f710f81313e3caa4
MD5 e3aeb9f0c7ee3d230f9e92b5e16b7bea
BLAKE2b-256 42b7d4261e51f13a7e0b6b099caf8b0db7ced6153b041c1f736b50e8abd0e7ce

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for framed_text-2026.3.31-py3-none-any.whl
Algorithm Hash digest
SHA256 3ecab1b6c53491f9597d095114cbcdcbb6d9b84c3e3bd494edda3ef24293fbca
MD5 c0b91e3fc649615ee01f2e71cf09c98e
BLAKE2b-256 4017c486185ab2a55513f3284e416732ccefcbeb2ced42eb03dc4608018f0051

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