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.AnyLabeledDataframed_text.AnyStatusframed_text.InvalidColorErrorframed_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
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file framed_text-2026.4.4.14.0.tar.gz.
File metadata
- Download URL: framed_text-2026.4.4.14.0.tar.gz
- Upload date:
- Size: 184.5 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/6.2.0 CPython/3.14.3
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
735a08aa08c696d487063ca7ccf3910e01a137e693bc12d89f97c8eef3f7a8a1
|
|
| MD5 |
9d2e3d096c0543154ede30bceee0f32c
|
|
| BLAKE2b-256 |
9b77c52195119a8a7bce447e06ad1e945967e37455e471634ad66b6d3488ae8a
|
File details
Details for the file framed_text-2026.4.4.14.0-py3-none-any.whl.
File metadata
- Download URL: framed_text-2026.4.4.14.0-py3-none-any.whl
- Upload date:
- Size: 27.0 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/6.2.0 CPython/3.14.3
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
f680919ebfbbbf796fbf05edf719c586682b970ba1e5e4ff97c08ecb587b5c5e
|
|
| MD5 |
aaa1de689d2513e19e39cc6ad492799c
|
|
| BLAKE2b-256 |
162e38ebe4b11b0b64f743faf87300fcf1ca55fd6e6d89e217838ac47ba69285
|