Skip to main content

A Python library for building web interfaces with dynamic and desktop features.

Project description

PyBootstrapUI

PyBootstrapUI is a Python framework for building modern web interfaces, integrating HTML components, dynamic user interactions, and creating desktop applications powered by NW.js.


Key Features

  • Dynamic UI: Build interactive web pages with server-side callbacks for user events.
  • Desktop Applications: Launch web pages as standalone desktop apps using NW.js.
  • Prebuilt Components: Access a library of ready-to-use HTML components like buttons, headers, forms, modals, and more.
  • Custom Templates: Use predefined themes or your own HTML templates for quick styling.
  • Seamless Integration: Works well with FastAPI and Bootstrap for modern web development.

Quick Start

Installation

  1. Install the package:

    pip install pybootstrapui
    
  2. Install NW.js if you plan to build desktop applications:


Basic Usage

Creating a Page

from pybootstrapui import Page
from pybootstrapui.components import Header, Button
from pybootstrapui.templates import Default

# Create a new page
page = Page(template_filename=Default, page_title="Hello PyBootstrapUI")

# Add components
page.add(Header(label="Welcome to PyBootstrapUI!", header_size=1))
page.add(Button(label="Click Me", btn_style_type="primary"))

# Generate HTML
print(page.compile())

Adding Callbacks

from pybootstrapui import Page
from pybootstrapui.components import Header, Button
from pybootstrapui.templates import Default

# Define a callback function
def on_button_click(context):
    print(f"Button clicked with ID: {context.id}")

# Create a page with a button callback
page = Page(template_filename=Default, page_title="Callback Demo")
page.add(Header(label="Dynamic Callbacks Example"))
page.add(Button(label="Click Me", btn_style_type="primary", callback=on_button_click))

# Run as a desktop application
page.run_in_desktop(
    nwjs_path="/path/to/nwjs",
    title="Callback App",
    width=800,
    height=600
)

Running as a Desktop App

Use the Page.run_in_desktop method to run your page as a desktop application.

from pybootstrapui import Page
from pybootstrapui.components import Header
from pybootstrapui.templates import Default

# Create the page
page = Page(template_filename=Default, page_title="My App")

# Add components
page.add(Header(label="This is a desktop app!"))

# Run the app
page.run_in_desktop(
    nwjs_path="/path/to/nwjs",
    icon="icon.png",
    title="My Desktop App",
    width=1024,
    height=768
)

Documentation

Comprehensive documentation is available at PyBootstrapUI Docs.


Links


License

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

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

pybootstrapui-1.0.4.tar.gz (38.7 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

pybootstrapui-1.0.4-py3-none-any.whl (90.6 kB view details)

Uploaded Python 3

File details

Details for the file pybootstrapui-1.0.4.tar.gz.

File metadata

  • Download URL: pybootstrapui-1.0.4.tar.gz
  • Upload date:
  • Size: 38.7 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.0.1 CPython/3.12.6

File hashes

Hashes for pybootstrapui-1.0.4.tar.gz
Algorithm Hash digest
SHA256 cfb19e1ac8e1ca9dbe4913b86e172f85a06997f3d520915a057f681873b91750
MD5 4b553228bfc2fa1f4c78db74326d980b
BLAKE2b-256 303761274ba0efe1c79cd32373a3a6c94dc4ac3a5dc428c6a8b12eb1a8c80ca5

See more details on using hashes here.

File details

Details for the file pybootstrapui-1.0.4-py3-none-any.whl.

File metadata

  • Download URL: pybootstrapui-1.0.4-py3-none-any.whl
  • Upload date:
  • Size: 90.6 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.0.1 CPython/3.12.6

File hashes

Hashes for pybootstrapui-1.0.4-py3-none-any.whl
Algorithm Hash digest
SHA256 831fae77d0ebfa619c89254aaef6870778327c52542fef46be555b0e75f0a240
MD5 e7f13fdae6f126e8cd427faa6f003903
BLAKE2b-256 931c249d76a7e6479177ac6700adae7ee955504243f28f848e97e43fc0ba60d2

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page