Qt Framework Documentation

Welcome to the Qt Framework documentation! This framework provides modern, modular Qt application development tools.

Getting Started

• Quick Start Guide
  • Installation
  • Your First Application
  • Adding Widgets
  • Using Themes
  • Next Steps

User Guides

• Theming Guide
  • Overview
  • Using Built-in Themes
  • Accessing Theme Colors
  • Creating Custom Themes
  • Hot Reload During Development
  • Theme Switching at Runtime
  • Design Token Reference
  • Font Scaling
  • Best Practices
  • Advanced: Custom Stylesheet Generation
  • Troubleshooting
• State Management Guide
  • Overview
  • Quick Start
  • Actions
  • Reducers
  • Store
  • Middleware
  • Connecting to UI
  • Complete Example
  • Best Practices
  • Debugging
• Navigation and Routing Guide
  • Overview
  • Quick Start
  • Defining Routes
  • Navigation
  • Route Guards
  • Nested Routes
  • Query Parameters
  • Navigation Events
  • Page Transitions
  • Complete Example
  • Best Practices
  • Advanced Topics
• Internationalization (i18n) Guide
  • Overview
  • Quick Start
  • Setup
  • Translation Functions
  • Extracting Translations
  • Translation Workflow
  • Runtime Language Switching
  • Formatting
  • Translatable Widgets
  • Context System
  • Best Practices
  • Advanced Topics
  • Complete Example
• Plugins Guide
  • Overview
  • Quick Start
  • Plugin Structure
  • Plugin Dependencies
  • Plugin Discovery
  • Plugin Configuration
  • Plugin Communication
  • Hot Reload
  • Plugin Hooks
  • Best Practices
  • Complete Example
  • Troubleshooting

Widgets

• ConfigEditorWidget
  • Features
  • Basic Usage
  • Field Types
  • Change Callbacks
  • Grouping Fields
  • Signals
  • Methods
  • Complete Example
  • Constructor Options
  • Best Practices
  • Comparison to Manual Implementation

API Reference

• API Reference
  • Core Modules
    • Core (qtframework.core)
    • Theming (qtframework.themes)
    • State Management (qtframework.state)
    • Navigation (qtframework.navigation)
    • Internationalization (qtframework.i18n)
    • Plugins (qtframework.plugins)
    • Configuration (qtframework.config)
    • Widgets (qtframework.widgets)
    • Layouts (qtframework.layouts)
    • Utilities (qtframework.utils)

Welcome to Qt Framework

Qt Framework is a modern, modular application framework for building sophisticated desktop applications with Python and PySide6.

🚀 Quick Start

Get started with Qt Framework in minutes

Quick Start Guide

🎨 Theming Guide

Learn about the token-based theming system

Theming Guide

🔄 State Management

Redux-inspired state management patterns

State Management Guide

🧭 Navigation

Routing and page navigation system

Navigation and Routing Guide

🌍 Internationalization

Multi-language support with Babel

Internationalization (i18n) Guide

🔌 Plugins

Build extensible applications with plugins

Plugins Guide

🧩 Widgets

Reusable widget components

ConfigEditorWidget

🔧 API Reference

Complete API documentation

API Reference

Key Features

• Modern Architecture - Built on PySide6 with modern Python patterns

• Modular Design - Extensible plugin system for custom components

• Type Safety - Full type hints and runtime validation with Pydantic

• Theming - Beautiful, customizable themes with hot-reload support

• i18n Support - Built-in internationalization with Babel

• Database Ready - SQLAlchemy integration with migration support

• Developer Friendly - Live reload, comprehensive logging, and debugging tools

Installation

pip install qt-framework

Or with development dependencies:

pip install "qt-framework[dev]"

Quick Example

from qtframework import Application, MainWindow

app = Application()
window = MainWindow(title="My App")
window.show()
app.exec()

Requirements

• Python 3.13+

• PySide6 6.8+

• Windows, macOS, or Linux

License

MIT License - see LICENSE for details.