Skip to main content

Python Rendered Objects for Backend-Oriented UI is A declarative, type-safe ,Python-Native template Rendering Framework and Meta-framework for Django.

Project description

🐘 Probo UI

PyPI Python License Docs Contributions Welcome Discord Last Commit Repo Size Tests APIs

Probo UI stands for Python Rendered Objects for Backend-Oriented UI is A Python-Native server-side Template Rendering Framework and Meta-framework for Django.Write Type-Safe Template Components, structure in HTML and styling in CSS with extra Logic in pure Python.that transforms Python objects into performant HTML/CSS with help with HTMX, creating a seamless bridge between Django's backend logic and the frontend interface. No context switching. No template spaghetti.

📣 Version 1.3.1 is Live!

Probo UI has officially reached stable v1.3 status. It is a backend-first framework.

u can chose how youre UI can be:

  • Note: all reserved python keywords are notated with capital letters e.g: id -> Id, class -> Class, map -> Map. in rendering phase the apropriate notaion is applied.

  • string based

from probo import (
    div, 
    span,
)

greeting_partial = div(span("Hello, Probo",Class='badge'))
  • object tree based
from probo import (
    DIV,
    SPAN,
    P,
)

greeting_partial = DIV(SPAN("Hello, Probo",Class='badge'))
greeting_partial.add(P('this is a paragraph'))

Why Probo?

  • use your python skill in making dynamic UI templates.
  • Explicit, readable and reusable layout
  • Easier refactoring than HTML templates (it's python)
  • IDE-friendly & type-safe

For the deeper reasoning behind these choices, see Purpose & Philosophy ↓

⚡ Purpose & Philosophy

Traditional Django development often requires context-switching between Python (views.py) and HTML/Jinja (templates/). Logic gets split, and typos in templates cause runtime errors.

Probo UI solves this by bringing the Frontend into Python:

🧠 Type-Safe UI: Write HTML in Python. If your code compiles, your HTML is valid.

🎨 Just-In-Time (JIT) CSS: Styles live with components. Probo UI scans your active components and generates a minified CSS bundle on the fly. No unused styles.

🛡️ Logic Gates: Built-in State Management. Components automatically hide themselves if required data (like user.is_authenticated) or permissions are missing.

🔌 Django Native: Deep integration with Django Forms and Requests via the RDT (Request Data Transformer).

Some ProboUI Architecture & Concepts

  • Push & Clear: When creating HTML elements via the Element object, the final output is pushed to the element attribute. The content and attributes used in that specific session are then cleared to maintain a clean state. To allow for cumulative processing, arguments can be passed to the class to "stash" previous results, serving as the content for the subsequent execution chain.

  • SSDOM (Server-Side DOM): Unlike traditional string-based templates, ProboUI treats HTML as a live object tree in Python. This allows for direct manipulation of the structure, attributes, and children of a component after its definition but before it is finalized into a string.

  • State Management: Enforces strict rendering constraints on components and elements via ComponentState and ElementState. To render an element, a props dictionary must be passed and validated against the expected schema; the rendering only proceeds if the state is valid.

  • CSS Sharing: Performance optimization where components can share the same CSS objects. This prevents the definition of redundant style objects and reduces memory overhead during large-scale renders.

  • Shared Execution: An internal efficiency pattern where every HTML tag is generated by the same unified logic under the hood, ensuring zero logic duplication and a consistent output format across the entire framework.

  • Head Registry: Instead of manually managing meta, link, and script tags, ProboUI uses a centralized registry. Developers use dedicated methods to register head elements, which the engine then constructs and optimizes automatically.

  • Template Switching: The Template engine allows you to construct a page and then dynamically modify or rebase its structure based on an entirely different template hierarchy, providing extreme flexibility in multi-layout applications.

  • Base Template: Provides a standardized, overrideable page structure that facilitates rapid development by allowing developers to inherit and manipulate a global foundation without starting from scratch.

  • Attribute Managers: Utilizes the ElementAttributeManipulator to manage an element's attributes. This creates a clean separation of concerns between the element's core logic and its HTML attribute state.

  • SDH (Static/Dynamic Hierarchy): Employs StaticData and DynamicData classes to resolve content within ElementState. The hierarchy prioritizes data in the order of Dynamic > Static > Content, which is used when binding these values to specific attribute values.

  • URL Component Mapping: Implemented via the TemplateComponentMap (TCM), this concept maps components to specific URLs. It allows for effortless discovery and access via URL names or slugified versions, bypassing manual route registration.

  • Django Syntax: Provides the ability to generate ProboUI output formatted as standard Django template syntax, allowing ProboUI components to be seamlessly embedded into existing .html templates within a Django environment.

  • HTMX Integration: Native support for creating HTMX-based elements, enabling high-speed, dynamic UX updates (partial page refreshes) without writing custom JavaScript.

  • Routing Engine: A built-in, Bottle-based server designed for rapid prototyping and testing of Python-based static web pages before production deployment.

  • Configs & Shortcuts: Utilizes specialized data classes to group configuration info for each shortcut execution, streamlining the API and reducing repetitive boilerplate code.

  • Component Styling: By linking CSS selectors directly to components and verifying their existence in the template, ProboUI prevents the delivery of "dead CSS" while still fully supporting standard CSS cascading.

  • Bootstrap 5 Support: Native integration for BS5 design tokens and components, allowing developers to implement professional layouts using familiar utility classes and components with zero extra configuration.

  • Probo-CLI: A command-line interface used to scaffold custom ProboUI packages as static web apps. It also enables "Django Mutation," automatically injecting the necessary Probo directories (components/, pages/, probo_tcm.py) into existing Django projects.

  • proxy element: The ProxyElement provides a mechanism to embed external logic or third-party objects directly into the SSDOM. It facilitates the integration of arbitrary objects by accepting the object and an optional render callable, which is utilized if the object does not possess a native render method.

Performance diagnostics

The following table demonstrates the Linear Scaling ($O(n)$) capability of the ProboUI engine. These benchmarks verify the efficiency of the "Unified Tree" architecture when handling massive data volumes.

Benchmarking Environment

  • Environment: GitHub Codespaces (Standard Tier)
  • Operations: Each test includes full Tree Build, a find operation, a add (modification), and a full render.
Elements Total String Length Build Phase Manipulation Render Phase Total Time
100 3,989 chars 0.0003s 0.0001s 0.0009s 0.0014s
1,000 41,789 chars 0.0076s 0.0001s 0.0087s 0.0164s
10,000 437,789 chars 0.0305s 0.0001s 0.0894s 0.1200s
100,000 4,577,789 chars 0.3335s 0.001s 0.8622s 1.1959s
250,000 11,777,789 chars 1.0517s 0.0001s 2.0606s 3.1125s
500,000 23,777,789 chars 1.9719s 0.001s 4.1436s 6.1156s
750,000 35,777,789 chars 3.8622s 0.0001s 6.1664s 10.0287s
1,000,000 47.777.789 chars 5.4940s 0.0001s 8.4081s 13.9022s

Observations

  • Constant-Time Manipulation: The "modification" phase (finding and adding nodes) remains consistently under 0.001s even with 1 million nodes in memory.
  • Memory Threshold: The framework engine successfully generated roughly a 48 MB HTML string. Scaling beyond 1.5 million elements typically hits the physical RAM limits of the containerized environment.
  • Linearity: ProboUI scales linearly. Doubling the element count consistently doubles the time, with no exponential "cliffs," making it safe for enterprise-scale documents.

📦 Installation

        pip install probo-ui

🚀 Quick Example

Here is how you implement a reusable component in probo-ui:

from probo import (
    li,div,h1,ul,strong,
)
def user_card(username):

    user_id = f'User_789{username}1323'

    user_info = {'practical-info':['python','javascript','docker','django']}

    li_el = [li(info) for info in user_info['practical-info']]

    card = div(
        h1(username,strong(user_id)),
        ul(*li_el)
        Class='card',
        style='color:red;'
    )

    return card

# Render it
html= user_card("Admin")
print(html)

Output:

    <div class='card'><h1>Admin<strong>User_789Admin1323</strong></h1><ul><li>python</li><li>javascript</li><li>docker</li><li>django</li></ul></div>

in case of permission based

from probo.components import (
    Component,ComponentState, ElementState,StateProps,
)
from probo import (
    div,h1,strong,ul,
)

def user_card(username):

    props = StateProps(required=True,prop_equal_to={'username':'admin'})
    
    user_id = f'User_789{username}1323'
    
    user_info = {'practical-info':['python','javascript','docker','django']}
    
    li_el = ElementState('li', d_state='practical-info',i_state=True, strict_dynamic=True,props=props,)
    
    user_comp_state = ComponentState(
        d_data=user_info,
        li_el,
    )

    card = Component(
        name="UserCard",
        template=div(
            h1(username,strong(user_id)),
            ul(li_el.placeholder)},
            Class='card'),
        # Inject Data
        state=user_comp_state,
        props={'username':username}
    )

    return card

# Render it
html= user_card("Admin").render()

html2= user_card("admin").render()

Output:

  • print(html)
    <div class='card'><h1>Admin<strong>User_789Admin1323</strong></h1><ul></ul></div>
  • print(html2)
    <div class='card'><h1>Admin<strong>User_789Admin1323</strong></h1><ul><li>python</li><li>javascript</li><li>docker</li><li>django</li></ul></div>

🚀 Get Started →

💬 Community & Support Need help? Have a question that isn't a bug? Join our Discord Server to chat with other probo-ui developers.

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

probo_ui-1.3.2.tar.gz (636.9 kB view details)

Uploaded Source

Built Distribution

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

probo_ui-1.3.2-py3-none-any.whl (221.8 kB view details)

Uploaded Python 3

File details

Details for the file probo_ui-1.3.2.tar.gz.

File metadata

  • Download URL: probo_ui-1.3.2.tar.gz
  • Upload date:
  • Size: 636.9 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.12.0

File hashes

Hashes for probo_ui-1.3.2.tar.gz
Algorithm Hash digest
SHA256 46e7fa921054585043a8caf49fe6ead0484b9bdaad9eaf4e09fd2a0b1a65c3c5
MD5 bd453d1dadb9c864912fb1224dcdbe0e
BLAKE2b-256 4091b5469ca4f8a529e8dc38ceb63565f7794b923a2d418f9d3d4a16d639ef77

See more details on using hashes here.

File details

Details for the file probo_ui-1.3.2-py3-none-any.whl.

File metadata

  • Download URL: probo_ui-1.3.2-py3-none-any.whl
  • Upload date:
  • Size: 221.8 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.12.0

File hashes

Hashes for probo_ui-1.3.2-py3-none-any.whl
Algorithm Hash digest
SHA256 80a9425fc4eb3b77e07a29edc334c43b5e30b49ac819aabf812f5928d186accd
MD5 595098f74bac4f43ba8d473e8e841493
BLAKE2b-256 25a0bd0d7a96159605d281d07d538cae7215d129de8d37ec83fc1f745d9c7659

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