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:

    • Download NW.js.
    • Or use the PyBootstrapUI command:
      python -m pybootstrapui download %path_to_nwjs%
      

📝 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", on_click=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
)

📦 Easy Packaging

Easily package and distribute your PyBootstrapUI applications with minimal effort!

🛠️ Step 1: Create a New Project

Generate a fully templated PyBootstrapUI project structure:

python -m pybootstrapui create MyProject

⚙️ Step 2: Build Your Application

Package your application into a standalone build:

python -m pybootstrapui build MyProject
  • Dependencies Management: All required packages are bundled.
  • Optimized Build Process: Ensures efficient and clean packaging.
  • Platform-Specific Binaries: Create executables for Windows, macOS, or Linux seamlessly.

📚 Documentation

Detailed API reference is available at PyBootstrapUI Docs.


🔗 Useful Links


📜 License

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


✨ Start building beautiful, dynamic, and cross-platform applications with PyBootstrapUI today! 🚀

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.8.3.tar.gz (66.0 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.8.3-py3-none-any.whl (122.6 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: pybootstrapui-1.0.8.3.tar.gz
  • Upload date:
  • Size: 66.0 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.8.3.tar.gz
Algorithm Hash digest
SHA256 a6bf95ff081db17c5b561a8c8bdb4c07f5fef968f1077386bfc7d260fee3e001
MD5 e71bc7b7dcf3751e186ead021fa81b53
BLAKE2b-256 3bff61003492bcf8a4b3b8d09ab4421548b1c22e58c47781c9c76cf0d431864e

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for pybootstrapui-1.0.8.3-py3-none-any.whl
Algorithm Hash digest
SHA256 d07d7509e2aba9b0c3fe772d14068902ca5bcd528df14f9dd5260716c72530b8
MD5 879287ab2697b289291b28e972d62c1a
BLAKE2b-256 f202e726b4b5ff8a3779635145618ddfdec9e84b97676fb587c04752372cb699

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