VIStk

A lightweight framework for building multi-screen Tkinter applications.

VIStk provides window and layout management, a project/screen registry, reusable widgets, a tabbed Host shell, and a CLI for scaffolding and releasing apps. Standard Tkinter widgets and geometry managers work alongside VIStk objects without conflict.

pip install VIStk

Quick example — create a project and launch it:

mkdir MyApp && cd MyApp
VIS new
VIS MyApp

Note

VIStk is under active development (0.4.4). API details may change between minor versions. See Changelog & Roadmap for the latest changes and Known Issues for open issues.

Getting Started

• Quickstart
  • 1. Install VIStk
  • 2. Create a project
  • 3. Understand the screen script
  • 4. Launch the app
  • 5. Add more screens
  • 6. Add UI elements to a screen
  • 7. Use layouts
  • 8. Add menus
  • 9. Release the app
  • Next steps

User Guide

• Concepts
  • Project Structure
  • App Lifecycle
  • Screen Module Pattern
  • The f_element Pattern
  • The #% Marker System
  • configure_menu Pattern
  • project.json
• CLI Reference
  • Initialize a project
  • Add a screen
  • Add elements to a screen
  • Add a menu module to a screen
  • Stitch a screen
  • Release the project
  • Release a single screen
  • Launch the Host
  • Rename a screen
  • Edit a screen attribute
  • Manage screen groups
  • Manage documentation URLs
  • Stop the Host
  • Check version

API Reference

• Objects
  • Root
  • Host
  • TabManager
  • DetachedWindow
  • SubRoot
  • Window
  • WindowGeometry
  • Layout
  • LayoutFrame
  • VIMG
  • ArgHandler
  • open_active_screen_docs (0.5.0)
• Widgets
  • TabBar
  • SplitView
  • HostMenu
  • InfoRow
  • ScrollableFrame
  • VISMenu
  • MenuItem
  • MenuWindow
  • ScrollMenu
  • QuestionWindow
  • WarningWindow
  • Tooltip (0.5.0)
  • CollapsibleFrame (0.5.0)
  • AutocompleteEntry (0.5.0)
  • DateEntry (0.5.0)
  • confirm / confirm_discard (0.5.0)
• Structures
  • VINFO
  • Project
  • Screen
  • IPC — send_to_host
  • Version
  • Release
• Utilities
  • fUtil
  • Templates and the #% System
  • Warnings

Project

• Changelog & Roadmap
• Known Issues