Metadata-Version: 2.4
Name: pylage
Version: 1.0.2
Summary: A server-driven differential UI framework for Python
Author-email: Rachit Kumar kanaujia <kanaujia.rachit1991@gmail.com>
License: Apache License
                                   Version 2.0, January 2004
                                http://www.apache.org/licenses/
        
           TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
        
           1. Definitions.
        
              "License" shall mean the terms and conditions for use, reproduction,
              and distribution as defined by Sections 1 through 9 of this document.
        
              "Licensor" shall mean the copyright owner or entity authorized by
              the copyright owner that is granting the License.
        
              "Legal Entity" shall mean the union of the acting entity and all
              other entities that control, are controlled by, or are under common
              control with that entity. For the purposes of this definition,
              "control" means (i) the power, direct or indirect, to cause the
              direction or management of such entity, whether by contract or
              otherwise, or (ii) ownership of fifty percent (50%) or more of the
              outstanding shares, or (iii) beneficial ownership of such entity.
        
              "You" (or "Your") shall mean an individual or Legal Entity
              exercising permissions granted by this License.
        
              "Source" form shall mean the preferred form for making modifications,
              including but not limited to software source code, documentation
              source, and configuration files.
        
              "Object" form shall mean any form resulting from mechanical
              transformation or translation of a Source form, including but
              not limited to compiled object code, generated documentation,
              and conversions to other media types.
        
              "Work" shall mean the work of authorship, whether in Source or
              Object form, made available under the License, as indicated by a
              copyright notice that is included in or attached to the work
              (an example is provided in the Appendix below).
        
              "Derivative Works" shall mean any work, whether in Source or Object
              form, that is based on (or derived from) the Work and for which the
              editorial revisions, annotations, elaborations, or other modifications
              represent, as a whole, an original work of authorship. For the purposes
              of this License, Derivative Works shall not include works that remain
              separable from, or merely link (or bind by name) to the interfaces of,
              the Work and Derivative Works thereof.
        
              "Contribution" shall mean any work of authorship, including
              the original version of the Work and any modifications or additions
              to that Work or Derivative Works thereof, that is intentionally
              submitted to Licensor for inclusion in the Work by the copyright owner
              or by an individual or Legal Entity authorized to submit on behalf of
              the copyright owner. For the purposes of this definition, "submitted"
              means any form of electronic, verbal, or written communication sent
              to the Licensor or its representatives, including but not limited to
              communication on electronic mailing lists, source code control systems,
              and issue tracking systems that are managed by, or on behalf of, the
              Licensor for the purpose of discussing and improving the Work, but
              excluding communication that is conspicuously marked or otherwise
              designated in writing by the copyright owner as "Not a Contribution."
        
              "Contributor" shall mean Licensor and any individual or Legal Entity
              on behalf of whom a Contribution has been received by Licensor and
              subsequently incorporated within the Work.
        
           2. Grant of Copyright License. Subject to the terms and conditions of
              this License, each Contributor hereby grants to You a perpetual,
              worldwide, non-exclusive, no-charge, royalty-free, irrevocable
              copyright license to reproduce, prepare Derivative Works of,
              publicly display, publicly perform, sublicense, and distribute the
              Work and such Derivative Works in Source or Object form.
        
           3. Grant of Patent License. Subject to the terms and conditions of
              this License, each Contributor hereby grants to You a perpetual,
              worldwide, non-exclusive, no-charge, royalty-free, irrevocable
              (except as stated in this section) patent license to make, have made,
              use, offer to sell, sell, import, and otherwise transfer the Work,
              where such license applies only to those patent claims licensable
              by such Contributor that are necessarily infringed by their
              Contribution(s) alone or by combination of their Contribution(s)
              with the Work to which such Contribution(s) was submitted. If You
              institute patent litigation against any entity (including a
              cross-claim or counterclaim in a lawsuit) alleging that the Work
              or a Contribution incorporated within the Work constitutes direct
              or contributory patent infringement, then any patent licenses
              granted to You under this License for that Work shall terminate
              as of the date such litigation is filed.
        
           4. Redistribution. You may reproduce and distribute copies of the
              Work or Derivative Works thereof in any medium, with or without
              modifications, and in Source or Object form, provided that You
              meet the following conditions:
        
              (a) You must give any other recipients of the Work or
                  Derivative Works a copy of this License; and
        
              (b) You must cause any modified files to carry prominent notices
                  stating that You changed the files; and
        
              (c) You must retain, in the Source form of any Derivative Works
                  that You distribute, all copyright, patent, trademark, and
                  attribution notices from the Source form of the Work,
                  excluding those notices that do not pertain to any part of
                  the Derivative Works; and
        
              (d) If the Work includes a "NOTICE" text file as part of its
                  distribution, then any Derivative Works that You distribute must
                  include a readable copy of the attribution notices contained
                  within such NOTICE file, excluding those notices that do not
                  pertain to any part of the Derivative Works, in at least one
                  of the following places: within a NOTICE text file distributed
                  as part of the Derivative Works; within the Source form or
                  documentation, if provided along with the Derivative Works; or,
                  within a display generated by the Derivative Works, if and
                  wherever such third-party notices normally appear. The contents
                  of the NOTICE file are for informational purposes only and
                  do not modify the License. You may add Your own attribution
                  notices within Derivative Works that You distribute, alongside
                  or as an addendum to the NOTICE text from the Work, provided
                  that such additional attribution notices cannot be construed
                  as modifying the License.
        
              You may add Your own copyright statement to Your modifications and
              may provide additional or different license terms and conditions
              for use, reproduction, or distribution of Your modifications, or
              for any such Derivative Works as a whole, provided Your use,
              reproduction, and distribution of the Work otherwise complies with
              the conditions stated in this License.
        
           5. Submission of Contributions. Unless You explicitly state otherwise,
              any Contribution intentionally submitted for inclusion in the Work
              by You to the Licensor shall be under the terms and conditions of
              this License, without any additional terms or conditions.
              Notwithstanding the above, nothing herein shall supersede or modify
              the terms of any separate license agreement you may have executed
              with Licensor regarding such Contributions.
        
           6. Trademarks. This License does not grant permission to use the trade
              names, trademarks, service marks, or product names of the Licensor,
              except as required for reasonable and customary use in describing the
              origin of the Work and reproducing the content of the NOTICE file.
        
           7. Disclaimer of Warranty. Unless required by applicable law or
              agreed to in writing, Licensor provides the Work (and each
              Contributor provides its Contributions) on an "AS IS" BASIS,
              WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
              implied, including, without limitation, any warranties or conditions
              of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
              PARTICULAR PURPOSE. You are solely responsible for determining the
              appropriateness of using or redistributing the Work and assume any
              risks associated with Your exercise of permissions under this License.
        
           8. Limitation of Liability. In no event and under no legal theory,
              whether in tort (including negligence), contract, or otherwise,
              unless required by applicable law (such as deliberate and grossly
              negligent acts) or agreed to in writing, shall any Contributor be
              liable to You for damages, including any direct, indirect, special,
              incidental, or consequential damages of any character arising as a
              result of this License or out of the use or inability to use the
              Work (including but not limited to damages for loss of goodwill,
              work stoppage, computer failure or malfunction, or any and all
              other commercial damages or losses), even if such Contributor
              has been advised of the possibility of such damages.
        
           9. Accepting Warranty or Additional Liability. While redistributing
              the Work or Derivative Works thereof, You may choose to offer,
              and charge a fee for, acceptance of support, warranty, indemnity,
              or other liability obligations and/or rights consistent with this
              License. However, in accepting such obligations, You may act only
              on Your own behalf and on Your sole responsibility, not on behalf
              of any other Contributor, and only if You agree to indemnify,
              defend, and hold each Contributor harmless for any liability
              incurred by, or claims asserted against, such Contributor by reason
              of your accepting any such warranty or additional liability.
        
           END OF TERMS AND CONDITIONS
        
           Copyright 2026 Rachit Kumar Kanaujia
        
           Licensed under the Apache License, Version 2.0 (the "License");
           you may not use this file except in compliance with the License.
           You may obtain a copy of the License at
        
               http://www.apache.org/licenses/LICENSE-2.0
        
           Unless required by applicable law or agreed to in writing, software
           distributed under the License is distributed on an "AS IS" BASIS,
           WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
           See the License for the specific language governing permissions and
           limitations under the License.
Project-URL: Homepage, https://github.com/aanalyst-rachit/pylage
Project-URL: Bug Tracker, https://github.com/aanalyst-rachit/pylage/issues
Keywords: ui,framework,server-driven,differential-ui,web
Classifier: Development Status :: 5 - Production/Stable
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: Apache Software License
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Topic :: Software Development :: User Interfaces
Classifier: Topic :: Internet :: WWW/HTTP :: Dynamic Content
Requires-Python: >=3.10
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: websockets>=10.0
Dynamic: license-file

# PyLage

PyLage is a reactive, server-driven differential UI framework for Python.

Build web interfaces as Python component trees, connect components to reactive state, and let PyLage render static HTML or synchronize live changes with a browser through its server-driven runtime.

PyLage is designed to keep application UI logic in Python while providing reusable components, reactive updates, styling, theming, layouts, forms, dashboards, feedback components, and browser synchronization.

## Features

* Pure Python UI component model
* Reactive `state` values with dependency tracking
* Server-driven UI updates
* Differential rendering and DOM patching
* Static HTML generation
* Live HTTP and WebSocket applications
* Two-way input binding through reactive state
* Built-in layout components such as `row`, `column`, `stack`, `grid`, `split`, and `container`
* Application and dashboard components
* Navigation, sidebar, drawer, modal, dialog, toast, tooltip, and overlay components
* Forms and input components
* Tables, lists, metrics, cards, and data-oriented components
* Built-in `style` and `theme` APIs
* Light and dark theme support
* Responsive UI primitives
* No frontend build system required for normal PyLage applications
* Stable lowercase public API
* Python 3.10 or newer
* 1090 passing tests in the current release verification suite

## Installation

PyLage 1.0.1 is distributed as a Python package.

```bash
pip install pylage

```

PyLage requires Python 3.10 or newer and depends on:

* `websockets>=10.0`

## Quickstart

A minimal PyLage application can be built directly from Python components.

```python
import pylage as pl

app = pl.column(
    pl.heading("Hello PyLage"),
    pl.text("A server-driven UI built entirely in Python."),
    pl.button("Click me"),
)

pl.run(app)

```

The public API uses lowercase names. Theme control is provided through set_theme and get_current_theme. Examples include column, row, text, heading, button, state, input, and style.

## Reactive State

Reactive state is created with `state`.

```python
import pylage as pl

count = pl.state(0)

def increment():
    count.set(count.value + 1)

app = pl.column(
    pl.heading(count),
    pl.button("Increment", on_click=increment),
)

pl.run(app)

```

When the state changes, PyLage tracks the affected component properties and updates the browser without requiring the application to rebuild the complete page manually.

The reactive pipeline is conceptually:

```text
State
  ↓
Dependency Graph
  ↓
Dirty Nodes
  ↓
Scheduler
  ↓
Component Tree
  ↓
Snapshot / Diff
  ↓
Patch
  ↓
WebSocket
  ↓
Browser DOM

```

Multiple synchronous state changes can be collected by the scheduler and applied as a single update cycle.

## Static and Live Rendering

PyLage can be used for static output as well as live server-driven applications.

Static rendering is useful when an HTML document is sufficient:

```python
pl.run(app, serve=False, output="dist/index.html")

```

For interactive applications, enable the live server mode:

```python
pl.run(app, serve=True)

```

In live mode, browser events are sent to the Python application through the WebSocket connection. Python-side state changes are then converted into differential updates and applied to the browser DOM.

## Two-Way Input Binding

Inputs can be connected directly to reactive state.

```python
import pylage as pl

name = pl.state("PyLage")

app = pl.column(
    pl.heading(name),
    pl.input(value=name),
)

pl.run(app, serve=True)

```

The same state can therefore drive displayed UI and receive changes from browser input events.

## Component Model

PyLage components are Python objects represented as a component tree.

| Category | Examples |
| --- | --- |
| **Basic UI** | `text`, `heading`, `button`, `icon`, `image`, `divider` |
| **Layout** | `container`, `row`, `column`, `stack`, `grid`, `split`, `center` |
| **Navigation** | `navigation`, `navigation_item`, `navbar`, `breadcrumb_trail`, `tabs`, `pagination` |
| **Application shell** | `app_shell`, `top_header`, `topbar`, `sidebar_layout`, `navigation_drawer`, `mobile_sidebar` |
| **Forms** | `form`, `form_field`, `input`, `textarea`, `checkbox`, `radio_group`, `select`, `slider`, `switch`, `datepicker` |
| **Data** | `table`, `data_list`, `dataframe`, `metric`, `metric_card`, `metric_grid`, `stat_group`, `trend` |
| **Dashboard** | `dashboard`, `dashboard_page`, `dashboard_header`, `dashboard_section`, `dashboard_card`, `dashboard_grid` |
| **Feedback** | `alert`, `toast`, `tooltip`, `popover`, `dialog`, `modal`, `confirmation_dialog` |
| **Loading** | `loading`, `loading_state`, `loading_overlay`, `spinner`, `skeleton` |
| **Content sections** | `hero`, `feature_section`, `content_section`, `contact_section`, `cta`, `faq`, `pricing_section`, `testimonial`, `newsletter_section`, `footer` |
| **Media** | `audio`, `video`, `canvas`, `carousel` |
| **Identity** | `avatar`, `badge`, `profile_page`, `authentication` |

The complete public root API is exposed through the `pylage` package.

## Layout

PyLage includes reusable layout primitives for composing interfaces without requiring a separate layout package.

```python
import pylage as pl

app = pl.row(
    pl.column(
        pl.heading("Navigation"),
        pl.button("Home"),
        pl.button("Settings"),
    ),
    pl.column(
        pl.heading("Content"),
        pl.text("Main application content"),
    ),
)

```

Useful layout primitives include:

* `container`
* `row`
* `column`
* `stack`
* `grid`
* `split`
* `center`
* `section`
* `two_column`
* `three_column`

Application-level layouts include:

* `app_shell`
* `top_header`
* `topbar`
* `sidebar_layout`
* `navigation_drawer`
* `mobile_sidebar`

## Styling

PyLage provides a Python styling API through `style`.

```python
import pylage as pl

app = pl.column(
    pl.heading("Styled UI"),
    pl.text("Styles are defined from Python."),
    style=pl.style(
        display="flex",
        flex_direction="column",
    ),
)

```

Styles can be supplied to components and composed with component defaults.
The styling system supports layout properties, typography, spacing, sizing, borders, backgrounds, responsive values, and other UI presentation concerns.

## Themes

PyLage provides a theme API for application-wide visual configuration.

```python
import pylage as pl

pl.set_theme("dark")

```

The current theme can also be accessed through:

```python
pl.get_current_theme()

```

Applications can use the built-in theme system or construct custom theme configurations where required.

## Server-Driven Architecture

PyLage follows a server-driven architecture.

```text
Python Application
       │
       ▼
Component Tree
       │
       ├── Props
       ├── State
       └── Events
       │
       ▼
Reactive Runtime
       │
       ├── Dependency Tracking
       ├── Dirty Node Tracking
       └── Scheduling
       │
       ▼
Snapshot / Differential Update
       │
       ▼
WebSocket Transport
       │
       ▼
Browser Runtime
       │
       ▼
DOM Update

```

The browser does not need to own the application state. Python remains the source of truth while the runtime synchronizes the browser representation.

## Events

Interactive components can receive Python callbacks.

```python
import pylage as pl

count = pl.state(0)

def increment():
    count.set(count.value + 1)

app = pl.column(
    pl.heading(count),
    pl.button("Increment", on_click=increment),
)

pl.run(app, serve=True)

```

The general event path is:

```text
Browser Event
  ↓
WebSocket Event Message
  ↓
Python Event Dispatcher
  ↓
Application Handler
  ↓
State Change
  ↓
Reactive Update
  ↓
Differential Browser Patch

```

## Browser Synchronization

Live PyLage applications use WebSocket communication to synchronize browser events and server-side updates.
The server can update:

* text content
* attributes
* properties
* component structure
* component children
* component ordering
* other supported differential UI state

The browser receives only the changes required by the current update rather than requiring a complete page reload.

## Public API

The stable public API is exposed from the root `pylage` package.
Examples include:

```python
import pylage as pl

pl.button(...)
pl.card(...)
pl.column(...)
pl.container(...)
pl.heading(...)
pl.input(...)
pl.row(...)
pl.state(...)
pl.style(...)
pl.text(...)
pl.run(...)

```

The public API is intentionally lowercase and was stabilized as part of the 1.0 release line.

## Testing

The current PyLage release has a verified test suite covering the public API, components, reactivity, rendering, runtime behavior, styling, themes, events, compatibility, and release checks.

Current verification:

* **1090 passed**

Release verification also covers:

* public API wrappers
* compatibility checks
* import audit
* package metadata
* demo imports
* package build
* wheel installation
* source distribution installation
* clean-environment imports
* release-facing functionality

## Project Structure

The final repository is organized around the current PyLage implementation:

```text
pylage/
├── demo/
├── docs/
├── pylage/
├── scripts/
├── test/
├── working_demo/
├── CHANGELOG.md
├── LICENSE
├── README.md
├── pyproject.toml
└── pytest.ini

```

The repository also contains release and development artifacts used during verification.

## Development

Clone the repository and create a Python 3.10+ virtual environment.

```bash
git clone https://github.com/aanalyst-rachit/pylage.git
cd pylage
python3 -m venv .venv
source .venv/bin/activate
pip install -e .

```

Run the test suite with:

```bash
pytest

```

Run the release verification suite with:

```bash
python3 scripts/verify_release.py

```

## Release

The current release is **PyLage 1.0.1**.

Release metadata is maintained in `pyproject.toml`.
The release history is documented in `CHANGELOG.md`.

## Repository History

The canonical `pylage` repository preserves the development histories of the related PyLage projects that preceded the consolidated release.
The final working tree follows the stabilized `pylage-ui-speed` implementation while preserving the historical Git lineage of:

* PyLage
* pylage-ui
* pylage_layout
* pylage-ui-speed

This preserves historical development context without retaining the obsolete source layouts from those earlier repositories.

## License

PyLage is distributed under the license included in the repository `LICENSE` file.

## Links

* **Repository:** [https://github.com/aanalyst-rachit/pylage](https://github.com/aanalyst-rachit/pylage)
* **Issues:** [https://github.com/aanalyst-rachit/pylage/issues](https://github.com/aanalyst-rachit/pylage/issues)

---

Aap chaho toh README audit start kar sakte hain. Aapka system validation execution ke liye ready hai!
