Bravura SDK - Quick Start Guide

Back to Documentation Hub

Bravura SDK - Quick Start Guide

Get up and running in 5 minutes with this concise reference guide.

For detailed explanations and tutorials, see GETTING_STARTED.md.

---

Quick Installation


# Install Bravura SDK from wheel file (in customer package)
pip install ./bravura_[tier]-1.0.0-py3-none-any.whl

# Replace [tier] with: standard, professional, or enterprise

# Example for Enterprise Edition:
# pip install ./bravura_enterprise-1.0.0-py3-none-any.whl

# Activate license using helper script
python license-helpers/activate_license.py

# Or manually in Python:
# from bravura import licensing
# license_manager = licensing.LicenseManager()
# license_manager.activate_license("YOUR-LICENSE-KEY", "your@email.com")

Note: Bravura is not available on PyPI. Install from the wheel file included in your customer package.

---

📦 Complete Import Reference

Core Framework


from bravura import Toolkit, ToolkitApp, ToolkitConfig

# Quick application framework
app = Toolkit(app_name="My App", theme="wigley_site")
app.run()

Documentation: GETTING_STARTED.md | API_REFERENCE.md

---

UI Components (All Tiers)


from bravura.components import (
    # Progress Bars
    BasicProgressBar,           # Clean, professional progress bar
    GradientProgressBar,        # Beautiful gradient progress bar

    # Framework Components
    StatusBar,                  # Professional status bar with timer/ETA
    MenuSystem,                 # Advanced menu system with shortcuts
    AnalysisTerminal,           # Real-time logging terminal
    UniversalLoadingDialog,     # Beautiful loading screens
)

# Helper functions (recommended)
from bravura.components import (
    create_status_bar,
    create_menu_system,
    create_analysis_terminal,
    create_basic_progress_bar,
    create_gradient_progress_bar,
)

Component Docs:

---

Premium UI Components (Professional+ Tier)


from bravura.components import (
    # Visual Effects (Professional+)
    AmbientBackground,          # Animated ambient glow effects
    GlassPanel,                 # Glass panel with backdrop effects

    # Advanced Progress (Professional+)
    GlowingProgressBar,         # Rainbow animated progress bar
    GlowingProgressManager,     # Manager for glowing progress bars

    # Interactive Components (Professional+)
    ToolTip,                    # Smart tooltip system
    RichToolTip,                # Rich tooltips with formatting
    HelpToolTip,                # Help-style tooltips
    ToastCenter,                # Toast notification system
    CommandPalette,             # Quick actions (Ctrl+K)
    ShortcutManager,            # Keyboard shortcuts system

    # GPU Detection (Professional+)
    GPUDetector,                # Cross-platform GPU detection
)

# Helper functions
from bravura.components import (
    create_ambient_background,
    create_glass_panel,
    create_modal_panel,
    add_tooltip,
    create_toast_center,
    show_info, show_success, show_warning, show_error,  # Toast shortcuts
    create_command_palette,
    create_shortcut_manager,
    add_shortcut_tooltip,
    detect_gpus,
    check_gpu_capabilities,
    create_gpu_detector,
)

Component Docs:

---

Button Components (All Tiers)


from bravura.components import (
    # Premium Buttons (All Tiers)
    PremiumButton,              # Hero actions with loading states
    CompactPremiumButton,       # Compact buttons for dense UIs
    ButtonFactory,              # Intelligent button selection
    IconButton,                 # Buttons with icons
    LoadingButton,              # Buttons with loading spinner
)

# Helper functions
from bravura.components import create_premium_button

# Usage examples
hero_btn = PremiumButton(parent, text="Save", command=save, style="primary")
compact_btn = CompactPremiumButton(parent, text="OK", command=ok, width=10)
auto_btn = ButtonFactory.create(parent, text="Action", context="hero")

Component Docs: BUTTON_USAGE_GUIDE.md | BUTTON_COLOR_CUSTOMIZATION.md

---

Theme System


from bravura import ThemeManager, WigleySiteTheme, WIGLEY_SITE_TOKENS

# Theme Manager (All Tiers)
theme_manager = ThemeManager(app)
theme_manager.apply_theme("dark")        # Standard themes
theme_manager.apply_theme("wigley_site") # Professional+ theme
theme_manager.apply_theme("platinum")    # Enterprise theme

# Access theme colors
colors = theme_manager.get_current_theme_colors()
accent = colors["accent_color_1"]

# Wigley Site Theme (Professional+)
from bravura import apply_wigley_theme
apply_wigley_theme(root)

# Direct token access (Professional+)
from bravura import WIGLEY_SITE_TOKENS
teal_color = WIGLEY_SITE_TOKENS["teal"]

Documentation: THEMING_GUIDE.md | CUSTOM_BRANDING_THEME.md

---

Utilities


from bravura import (
    Worker,                     # Background task worker
    GPUDetector,                # GPU detection
    ProgressTracker,            # Progress tracking
)

# Version and license info
from bravura import get_version_info, get_license_info
version = get_version_info()
license = get_license_info()

# System compatibility check
from bravura import check_system_compatibility
compat = check_system_compatibility()

---

🚀 Minimal Application


from bravura import Toolkit

# Create and run in 2 lines
app = Toolkit(app_name="My App", theme="wigley_site")
app.run()

---

âš¡ Quick Examples by Use Case

Loading Screen


from bravura.components import create_loading_dialog

loading = create_loading_dialog()
loading.show()
# ... do work ...
loading.close()

Docs: UNIVERSAL_LOADING_DIALOG_COMPONENT_GUIDE.md

Progress Bar


from bravura.components import BasicProgressBar

progress = BasicProgressBar(parent, style="standard", width=400)
progress.pack()
progress.set_value(75)  # 75%

Toast Notification (Professional+)


from bravura.components import show_success, show_error

show_success(root, "Operation completed!")
show_error(root, "Something went wrong")

Menu System


from bravura.components import create_menu_system

menu = create_menu_system(root)
menu.add_menu("File", [
    {"label": "New", "command": new_file, "accelerator": "Ctrl+N"},
    {"label": "Open", "command": open_file, "accelerator": "Ctrl+O"},
    "separator",
    {"label": "Exit", "command": root.quit}
])

Ambient Background (Professional+)


from bravura.components import AmbientBackground

ambient = AmbientBackground(
    root,
    theme_tokens=theme_manager.get_current_theme_colors(),
    particle_count=30,
    animation_speed="medium"
)

Docs: AMBIENT_BACKGROUND_USAGE.md

Glass Panel (Professional+)


from bravura.components import create_glass_panel

panel = create_glass_panel(
    parent,
    width=400,
    height=300,
    title="Settings"
)
panel.pack(padx=20, pady=20)

Docs: GLASS_PANEL_USAGE.md

---

📚 Next Steps

  1. GETTING_STARTED.md - Comprehensive tutorial with detailed explanations
  2. API_REFERENCE.md - Complete API documentation
  3. FEATURES_OVERVIEW.md - See all capabilities
  4. INTEGRATION_GUIDE.md - Build production applications

---

🎯 Component-Specific Documentation

Component Quick Ref Full Guide
AmbientBackground Quick AMBIENT_BACKGROUND_USAGE.md
Buttons Quick BUTTON_USAGE_GUIDE.md
GlassPanel Quick GLASS_PANEL_USAGE.md
LoadingDialog Quick UNIVERSAL_LOADING_DIALOG_COMPONENT_GUIDE.md
MenuSystem Quick API_REFERENCE.md
ProgressBars Quick API_REFERENCE.md
StatusBar API_REFERENCE.md API_REFERENCE.md
Themes Quick THEMING_GUIDE.md
Toasts Quick TOAST_STYLES.md

---

© 2025 Wigley Studios LLC. Professional Python GUI Framework.