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.

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

poetry install

Running

poetry run uvicorn examples.app:app --reload

Then go to http://localhost:8000/

Poetry Install

brew install pipx
pipx install poetry
pipx ensurepath

(see https://python-poetry.org/docs/#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.0.23.tar.gz (75.6 kB view details)

Uploaded Source

Built Distribution

pyview_web-0.0.23-py3-none-any.whl (85.7 kB view details)

Uploaded Python 3

File details

Details for the file pyview_web-0.0.23.tar.gz.

File metadata

  • Download URL: pyview_web-0.0.23.tar.gz
  • Upload date:
  • Size: 75.6 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/5.1.1 CPython/3.12.5

File hashes

Hashes for pyview_web-0.0.23.tar.gz
Algorithm Hash digest
SHA256 f4786d8c54443ed963fe1289e0bc24fafe4d5bdeab3ee803697ada648274cbe5
MD5 feb7097a353c3bcd62d7b82f933a622b
BLAKE2b-256 2e1b169e5976b12769b7c702eae7655d15ffcbb8f9bba5a4dd6bdd3109a7d4e6

See more details on using hashes here.

File details

Details for the file pyview_web-0.0.23-py3-none-any.whl.

File metadata

  • Download URL: pyview_web-0.0.23-py3-none-any.whl
  • Upload date:
  • Size: 85.7 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/5.1.1 CPython/3.12.5

File hashes

Hashes for pyview_web-0.0.23-py3-none-any.whl
Algorithm Hash digest
SHA256 f789103cbf9686c4ed5461a80df7f4d940df404ca282f25f8d291690ac21452b
MD5 69f3ed57abe5ea1b54757a8ffa21642e
BLAKE2b-256 7fcf06e076c419eba4bede93b81f2d5b80dc8709fdfb4590e12db4ab77996b9c

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page