Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/ogrodnek/pyview
A Python implementation of Phoenix LiveView
https://github.com/ogrodnek/pyview
liveview python web websockets
Last synced: 2 days ago
JSON representation
A Python implementation of Phoenix LiveView
- Host: GitHub
- URL: https://github.com/ogrodnek/pyview
- Owner: ogrodnek
- License: mit
- Created: 2023-04-19T00:18:11.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2024-09-17T23:40:48.000Z (about 2 months ago)
- Last Synced: 2024-09-18T03:24:21.799Z (about 2 months ago)
- Topics: liveview, python, web, websockets
- Language: Python
- Homepage: https://examples.pyview.rocks
- Size: 715 KB
- Stars: 25
- Watchers: 3
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: readme.md
- License: LICENSE
Awesome Lists containing this project
README
# 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](https://github.com/cookiecutter/cookiecutter) template available
```
cookiecutter gh:ogrodnek/pyview-cookiecutter
```
# Live Examples
[https://examples.pyview.rocks/](https://examples.pyview.rocks/)
## Other Examples
- [pyview AI chat](https://github.com/pyview/pyview-example-ai-chat)
- [pyview auth example](https://github.com/pyview/pyview-example-auth) (using [authlib](https://docs.authlib.org/en/latest/))
## Simple Counter
[See it live!](https://examples.pyview.rocks/count)
count.py:
```python
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:
```html
Count is {{count}}
-
+
```
# Acknowledgements
- Obviously this project wouldn't exist without [Phoenix LiveView](https://github.com/phoenixframework/phoenix_live_view), which is a wonderful paradigm and implementation. Besides using their ideas, we also directly use the LiveView JavaScript code.
- Thanks to [Donnie Flood](https://github.com/floodfx) for the encouragement, inspiration, help, and even pull requests to get this project started! Check out [LiveViewJS](https://github.com/floodfx/liveviewjs) for a TypeScript implementation of LiveView (that's much more mature than this one!)
- Thanks to [Darren Mulholland](https://github.com/dmulholl) for both his [Let's Build a Template Language](https://www.dmulholl.com/lets-build/a-template-language.html) tutorial, as well as his [ibis template engine](https://github.com/dmulholl/ibis), which he very generously released into the public domain, and forms the basis of templating in PyView.
## Additional Thanks
- We're using the [pubsub implementation from flet](https://github.com/flet-dev/flet)
- PyView is built on top of [Starlette](https://www.starlette.io/).
# 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](LICENSE).