Skip to main content

LiveView in Python

Project description

PyView

A Python implementation of Phoenix LiveView

PyView enables dynamic, real-time web apps, using server-rendered HTML.

Documentation: https://pyview.rocks

Source Code: https://github.com/ogrodnek/pyview

Installation

pip install pyview-web

Quickstart

There's a cookiecutter template available

cookiecutter gh:ogrodnek/pyview-cookiecutter

Live Examples

https://examples.pyview.rocks/

Other Examples

Simple Counter

See it live!

count.py:

from pyview import LiveView, LiveViewSocket
from typing import TypedDict


class CountContext(TypedDict):
    count: int


class CountLiveView(LiveView[CountContext]):
    async def mount(self, socket: LiveViewSocket[CountContext], _session):
        socket.context = {"count": 0}

    async def handle_event(self, event, payload, socket: LiveViewSocket[CountContext]):
        if event == "decrement":
            socket.context["count"] -= 1

        if event == "increment":
            socket.context["count"] += 1

    async def handle_params(self, url, params, socket: LiveViewSocket[CountContext]):
        if "c" in params:
            socket.context["count"] = int(params["c"][0])

count.html:

<div>
  <h1>Count is {{count}}</h1>
  <button phx-click="decrement">-</button>
  <button phx-click="increment">+</button>
</div>

Acknowledgements

  • Obviously this project wouldn't exist without Phoenix LiveView, which is a wonderful paradigm and implementation. Besides using their ideas, we also directly use the LiveView JavaScript code.

  • Thanks to Donnie Flood for the encouragement, inspiration, help, and even pull requests to get this project started! Check out LiveViewJS for a TypeScript implementation of LiveView (that's much more mature than this one!)

  • Thanks to Darren Mulholland for both his Let's Build a Template Language tutorial, as well as his ibis template engine, which he very generously released into the public domain, and forms the basis of templating in PyView.

Additional Thanks

Status

PyView is in the very early stages of active development. Please check it out and give feedback! Note that the API is likely to change, and there are many features that are not yet implemented.

Running the included Examples

Setup

uv sync

Running

uv run uvicorn examples.app:app --reload

Then go to http://localhost:8000/

uv Install

brew install uv

or

curl -LsSf https://astral.sh/uv/install.sh | sh

(see https://docs.astral.sh/uv/getting-started/installation/ for more details)

License

PyView is licensed under the MIT License.

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

pyview_web-0.9.0a4.tar.gz (137.6 kB view details)

Uploaded Source

Built Distribution

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

pyview_web-0.9.0a4-py3-none-any.whl (162.7 kB view details)

Uploaded Python 3

File details

Details for the file pyview_web-0.9.0a4.tar.gz.

File metadata

  • Download URL: pyview_web-0.9.0a4.tar.gz
  • Upload date:
  • Size: 137.6 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.7

File hashes

Hashes for pyview_web-0.9.0a4.tar.gz
Algorithm Hash digest
SHA256 5ae83012af95c137c53780a2a8c525e386487c166847c9e0af77543b18e2df6b
MD5 98ad6031be21839b084259eed00cd1fc
BLAKE2b-256 96436c7660d30c6c796b473d89e567d41ddf79e337a945814e49f0a2deae0db8

See more details on using hashes here.

Provenance

The following attestation bundles were made for pyview_web-0.9.0a4.tar.gz:

Publisher: release.yml on ogrodnek/pyview

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file pyview_web-0.9.0a4-py3-none-any.whl.

File metadata

  • Download URL: pyview_web-0.9.0a4-py3-none-any.whl
  • Upload date:
  • Size: 162.7 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.7

File hashes

Hashes for pyview_web-0.9.0a4-py3-none-any.whl
Algorithm Hash digest
SHA256 b49bd70b117bfe452ca39ef7031095db4aa2262e00d947ccbc7b328789d379cc
MD5 e978410d67dd679fcf4525c86cb3d781
BLAKE2b-256 a5a38bea9b9fb5585991cb314d215b0c229af8d9cace837ce289baa134f083df

See more details on using hashes here.

Provenance

The following attestation bundles were made for pyview_web-0.9.0a4-py3-none-any.whl:

Publisher: release.yml on ogrodnek/pyview

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

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