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.5.tar.gz (40.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.5-py3-none-any.whl (93.4 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: pybootstrapui-1.0.5.tar.gz
  • Upload date:
  • Size: 40.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.5.tar.gz
Algorithm Hash digest
SHA256 be12ff4fee4c62c402fe53719a0739a4b6856fa8579b7e227146c8b7eec17c5c
MD5 808d61a5bfa1bd5270d317f2cdacc0b4
BLAKE2b-256 36840f22cf05181562f1d55cb140b956289061549008f149b50a8f6ab496275a

See more details on using hashes here.

File details

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

File metadata

  • Download URL: pybootstrapui-1.0.5-py3-none-any.whl
  • Upload date:
  • Size: 93.4 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.5-py3-none-any.whl
Algorithm Hash digest
SHA256 dd20112e2cb848718e0641f9782d2c2e5a25c19d7303b198b0d79e2861a94eee
MD5 c81310659e9c91c756550a43396c0e8a
BLAKE2b-256 89d259cdee7023e8f53a56c19d8fc55a615a3d9be82ffdabae1999dce39ff188

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