LazyFast = FastAPI + HTMX + Component-based approach + State management
Project description
LazyFast
LazyFast is a lightweight Python library designed for building modern web interfaces using a component-based approach. It enables writing page logic on the server side in Python, integrating seamlessly with FastAPI. With LazyFast, interactive elements like inputs, buttons, and selects trigger component reloads that occur on the server, updating the component's state dynamically.
Key Features
- Component-Based Server Rendering: Build web interfaces using lazy loaded components that encapsulate logic, state, and presentation.
- Server-Side Logic: Handle interactions and state management on the server, reducing client-side complexity.
- FastAPI Integration: Each component or page is a FastAPI endpoint, allowing for dependency injection and other FastAPI features.
- Lightweight: The only dependencies are FastAPI for Python and HTMX for JavaScript, which can be included via CDN.
- State Management: Utilize a state manager that can trigger component reloads, ensuring a reactive user experience.
Installation
To install LazyFast, use pip:
pip install lazyfast
or
poetry add lazyfast
Quick Start
Here's an example application to demonstrate how LazyFast works:
from fastapi import FastAPI, Request
from lazyfast import LazyFastRouter, Component, tags
# LazyFastRouter inherits from FastAPI's APIRouter
router = LazyFastRouter()
# Define a lazy-loaded HTML component powered by HTMX
@router.component()
class MyComponent(Component):
# Define a state field to store the component's value
# We can pass this value from parent page or component
# Or we can use it as local component state
title: str
# Override the view method to define HTML rendering logic
# The view method is a FastAPI endpoint supporting dependency injection
async def view(self, request: Request) -> None:
# Use familiar HTML tags as Python objects with standard HTML attributes
# The first parameter is the inner HTML of the tag
tags.h1(self.title, class_="my-class")
# Use the "with" operator to add additional HTML tags to the inner HTML
with tags.div(style="border: 1px solid black"):
# This span is a child of the div
tags.span(request.headers)
# Initialize the page dependencies for component rendering
# The page endpoint is also a FastAPI endpoint
@router.page("/{name}")
def root(name: str):
with tags.div(class_="container mt-6"):
# Initialize this component to embed an HTMX div and trigger the view method only after the div is rendered
MyComponent(title=f"Hello, World from {name}")
# Embed the router in a FastAPI app
app = FastAPI()
app.include_router(router)
If you use uvicorn
instead as a server and want to reload on changes, use the following command:
uvicorn app:app --reload --timeout-graceful-shutdown 1
Documentation
Coming soon.
License
LazyFast is licensed under the MIT License.
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for lazyfast-0.1.10-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 0b7145b5d29bde8e4c4a4296b3313b589b4af26f5e60fdae58424b0ccdf154c0 |
|
MD5 | d2dc16640dd749a043169c55cec5a204 |
|
BLAKE2b-256 | 3f2d98181432a8e359eba443762bd9442224bf9b04315cce7ca82fe59dae9759 |