pepperpy-console 0.2.1

PepperPy console package

PepperPy Console

A powerful Python library for building text-based user interfaces (TUI) with a focus on extensibility and ease of use.

Features

• 🎨 Theme Support: Customizable appearance with built-in themes
• 🔌 Plugin System: Easy to extend with custom plugins
• 🎯 CLI Framework: Robust command-line interface system
• 📱 TUI Components: Rich set of text user interface widgets
• 🔄 Event System: Comprehensive event handling
• 🔒 Type Safety: Full type hints support
• ⚡ Async Support: Built with asyncio for modern Python applications

Installation

pip install pepperpy-console

Quick Start

from pepperpy_console import PepperApp, PepperScreen, Static

class WelcomeScreen(PepperScreen):
    async def compose(self):
        yield Static("Welcome to PepperPy Console!")

class MyApp(PepperApp):
    async def on_mount(self):
        await self.push_screen(WelcomeScreen())

if __name__ == "__main__":
    app = MyApp()
    app.run()

Documentation

Visit our documentation for:

• CLI System Guide
• TUI Framework Guide
• Theme System Guide
• Examples
• API Reference

Examples

CLI Application

from pepperpy_console import PepperApp, Command

class CLIApp(PepperApp):
    def __init__(self):
        super().__init__()
        self.setup_commands()

    def setup_commands(self):
        async def greet(name: str):
            return f"Hello, {name}!"

        self.commands.add_command(Command(
            name="greet",
            callback=greet,
            description="Greet someone"
        ))

app = CLIApp()
app.run()

Data Table

from pepperpy_console import (
    PepperApp,
    PepperScreen,
    PepperTable,
    Column
)

class DataScreen(PepperScreen):
    def __init__(self):
        super().__init__()
        self.table = PepperTable()

    def setup_table(self):
        self.table.add_column(Column("ID"))
        self.table.add_column(Column("Name"))
        self.table.add_row("1", "Item 1")

    async def compose(self):
        self.setup_table()
        yield self.table

app = PepperApp()
app.push_screen(DataScreen())
app.run()

Contributing

We welcome contributions! Please see our Contributing Guide for details.

Development

1. Clone the repository:

git clone https://github.com/yourusername/pepperpy-console.git
cd pepperpy-console

2. Install dependencies:

poetry install

3. Run tests:

poetry run pytest

License

This project is licensed under the MIT License - see the LICENSE file for details.

Acknowledgments

• Built with Textual
• Inspired by modern Python libraries and frameworks

Support

• 📖 Documentation
• 💬 Discord Community
• 📝 GitHub Issues
• 📧 Email Support