outlify 0.10.0

Structured cli output — beautifully, simply, and dependency-free

Structured cli output — beautifully, simply, and dependency-free.

Overview • Install • Usage • Components • License

Overview

Outlify is designed with a focus on streamlined log output, making it perfect for cli tools. It emphasizes lightweight operation and minimal dependencies, ensuring smooth integration into any project. The second key aspect of Outlify is its beautiful and user-friendly log formatting, designed to enhance readability and provide a pleasant experience for developers and their users.

Install

Outlify is available as a Python package and can be easily installed via pip from PyPI.

To install, simply run the following command:

pip install outlify

This will automatically install the latest version of Outlify.

Usage

You can view demos of any available modules by running the following command:

python -m outlify.module_name

For example, to view the demo for the Panel module:

python -m outlify.panel

Components

Outlify provides simple, elegant components for clean and structured CLI output — with zero dependencies. They help organize information clearly and improve log readability.

Each component is easy to use and comes with built-in demos. See below for examples and usage.

Static

Panels

To highlight important text by displaying it within a panel, use Panel. Here's how:

from outlify.panel import Panel

print(Panel('A very important text', title='Warning'))

To display parameters in a structured format, use the ParamsPanel:

from outlify.panel import ParamsPanel

parameters = {'parameter1': 'value1', 'parameter2': 'value2'}
print(ParamsPanel(parameters, title='Startup Parameters'))

For more details on how to use Panels, see Panels

Lists

If you need a simple titled list in structured output, use TitledList:

from outlify.list import TitledList

packages = ['first', 'second', 'third']
print(TitledList(packages))

For more details on how to use Lists, see Lists

Styles

To styling text and Outlify elements, use Colors and Styles:

from outlify.style import Colors, Styles

print(f'{Colors.red}{Styles.bold}text')

For more details on how to use Style, see Style

Decorators

You can also use Outlify's utility Decorators

import time
from outlify.decorators import timer

@timer()
def dummy():
    time.sleep(1)

dummy()

For more details on how to use Style, see Decorators

License

Licensed under the MIT License, Copyright (c) 2025 Vladislav Kishkin