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.4.29.16.30.tar.gz (197.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.29.16.30-py3-none-any.whl (27.2 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: framed_text-2026.4.29.16.30.tar.gz
  • Upload date:
  • Size: 197.6 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.4.29.16.30.tar.gz
Algorithm Hash digest
SHA256 ce0e7d2834ac5c9790b628bb6a13cce8f4d79dc3185ba4bace66b5543b812c43
MD5 6ec89178e30d0ded7a79faf8b9c89238
BLAKE2b-256 76b13980ae51e28827332e917a7bf26a27151e12b0c8b6f28b3dd80536287817

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for framed_text-2026.4.29.16.30-py3-none-any.whl
Algorithm Hash digest
SHA256 7d9ec39de203acd3da6a0f0f1dd1c00c349b72ede01e53027cf11e9f5f9d8a20
MD5 7929fb406e5fee95c369a6f47809f964
BLAKE2b-256 b241e67c6def2da811df2d12dc8eb77c4a14975d9c07e47982c2a6f9c98c7143

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