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.2.tar.gz (38.6 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.2-py3-none-any.whl (90.5 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: pybootstrapui-1.0.2.tar.gz
  • Upload date:
  • Size: 38.6 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.2.tar.gz
Algorithm Hash digest
SHA256 2572eb46bc61b12ad2c530c55374b65d2df713537837fc829117b97cd4c1bd25
MD5 9357273aec3b5f3bd96090c842c5c007
BLAKE2b-256 305b4f7da4bd7a8b12ff3e32ae33b8e4989fd9b0ffc6d42ab1b5d547e730777b

See more details on using hashes here.

File details

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

File metadata

  • Download URL: pybootstrapui-1.0.2-py3-none-any.whl
  • Upload date:
  • Size: 90.5 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.2-py3-none-any.whl
Algorithm Hash digest
SHA256 729c9a3af0b1b382a5bcfb7ad9d73461293af7688791ab886352cb29b03a018f
MD5 e069f7bf8b6ca1f161b727b6f7173919
BLAKE2b-256 2adc23d83bcb8a56252e018e02fd0ce222c35429db68a35651b1278598c3d808

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