Back to search
ludic
SkillGitHub
🌳 A type-safe HTML template engine for Python. Build dynamic web pages using Python components with a React-like approach.
Safety scan
A static text scan, not a guarantee. Select the badge to see what was scanned and every finding.
Checked yesterday
Badge for your README
Markdown
[](/listings/getludic--ludic)HTML
<a href="/listings/getludic--ludic"><img src="/api/listings/getludic--ludic/badge.svg" alt="findsafeskills safety rating" /></a>Install
i
Install instructions from the README
As written by the repo's author. findsafeskills has not verified these steps.
pip install "ludic[full]"
You can also use a basic cookiecutter template to get quickly started, using [UV](https://docs.astral.sh/uv/), you need to run only one command:
uvx cookiecutter gh:getludic/template
What was scanned
The files the safety scan read, as written by the repository's author and shown as plain text. Lines with a finding are marked.
README.md · README · 221 lines
- <p align="center">
- <img width="600px" src="https://raw.githubusercontent.com/getludic/ludic/main/docs/assets/ludic.png" alt="Ludic Logo">
- </p>
- [](https://github.com/getludic/ludic/actions) [](https://codecov.io/gh/getludic/ludic) [](https://www.python.org/downloads/) [](http://mypy-lang.org/) [](https://discord.gg/7nK4zAXAYC)
- **Documentation**: https://getludic.dev/docs/
- ---
- *"I've just composed my first `PageLayout` component and I have no words!"*
- – Igor Davydenko
- ---
- Ludic is a lightweight framework for building HTML pages with a component approach similar to [React](https://react.dev/). It is built to be used together with [htmx.org](https://htmx.org/) so that developers don't need to write almost any JavaScript to create dynamic web services. Its potential can be leveraged together with its web framework which is a wrapper around the powerful [Starlette](https://www.starlette.io/) framework. Version 1.x leverages Python 3.14's new t-strings (template strings) for safer and simpler HTML templating.
- ## Features
- - Seamless **</> htmx** integration for rapid web development in **pure Python**
- - **Type-Guided components** utilizing Python's typing system
- - Uses the power of **Starlette** and **Async** for high-performance web development
- - Build HTML with the ease and power of Python **t-strings** (template strings)
- - Enhanced **security** with automatic escaping and clear separation of trusted vs untrusted content
- - Add CSS styling to your components with **Themes**
- - Create simple, responsive layouts adopted from the **Every Layout Book**
- ## Comparison
- Here is a table comparing Ludic to other similar tools:
- | Feature | Ludic | FastUI | Reflex |
- |-----------------------------|-------------|-------------|-------------|
- | HTML rendering | Server Side | Client Side | Client Side |
- | Uses a template engine | No | No | No |
- | UI interactivity | [</> htmx](https://htmx.org)* | [React](https://react.dev/) | [React](https://react.dev/) |
- | Backend framework | [Starlette](https://www.starlette.io), [FastAPI](https://fastapi.tiangolo.com/), [Django](https://www.djangoproject.com/)* | [FastAPI](https://fastapi.tiangolo.com) | [FastAPI](https://fastapi.tiangolo.com) |
- | Client-Server Communication | [HTML + REST](https://htmx.org/essays/how-did-rest-come-to-mean-the-opposite-of-rest/) | [JSON + REST](https://github.com/pydantic/FastUI?tab=readme-ov-file#the-principle-long-version) | [WebSockets](https://reflex.dev/blog/2024-03-21-reflex-architecture/) |
- <sup>(*) HTMX as well as Starlette, FastAPI and Django are optional dependencies for Ludic, it does not enforce any frontend or backend frameworks. At it's core, Ludic only generates HTML and allows registering CSS.</sup>
- ## Motivation
- This framework allows HTML generation in Python while utilizing Python's typing system. Our goal is to enable the creation of dynamic web applications with reusable components, all while offering a greater level of type safety than raw HTML.
- **Key Ideas:**
- - **Type-Guided HTML**: Catch potential HTML structural errors at development time thanks to type hints. The framework enforces stricter rules than standard HTML, promoting well-structured and maintainable code.
- - **Composable Components**: Define reusable, dynamic HTML components in pure Python. This aligns with modern web development practices, emphasizing modularity.
- ### Type-Guided HTML
- Here is an example of how Python's type system can be leveraged to enforce HTML structure:
- ```python
- br("Hello, World!") # type error (<br> can't have children)
- br() # ok
- html(body(...)) # type error (first child must be a <head>)
- html(head(...), body(...)) # ok
- div("Test", href="test") # type error (unknown attribute)
- a("Test", href="...") # ok
- ```
- ### Composable Components
- Instead of using only basic HTML elements, it is possible to create modular components with the support of Python's type system. Let's take a look at an example:
- ```python
- Table(
- TableHead("Id", "Name"),
- TableRow("1", "John"),
- TableRow("2", "Jane"),
- TableRow("3", "Bob"),
- )
- ```
- This structure can be type-checked thanks to Python's rich type system. Additionally, this `Table` component could have **dynamic properties** like sorting or filtering.
- ## Migration from v0.5 to v1.0
- Ludic 1.0 requires Python 3.14+ and introduces a major change: **t-strings (template strings)** replace the previous f-string approach with `FormatContext`. This provides better performance, simpler code, and enhanced security.
- ### Key Changes
- **Replace `f"` with `t"`** when mixing HTML elements with text:
- ```python
- # v0.5 (f-strings)
- div(f"Hello {b('World')}")
- # v1.0 (t-strings)
- div(t"Hello {b('World')}")
- ```
- ### Version Compatibility
- - **Ludic 0.5.x**: Python 3.12, 3.13 (uses f-strings)
- - **Ludic 1.0.x**: Python 3.14+ (uses t-strings)
- ## Requirements
- Python 3.14+
- **Note:** Ludic 1.x requires Python 3.14+ for t-string support. If you're using Python 3.12 or 3.13, please use Ludic 0.5.x which uses f-strings instead.
- ## Installation
- ```
- pip install "ludic[full]"
- ```
- You can also use a basic cookiecutter template to get quickly started, using [UV](https://docs.astral.sh/uv/), you need to run only one command:
- ```
- uvx cookiecutter gh:getludic/template
- ```
- ## Full Example
- **components.py**:
- ```python
- from typing import override
- from ludic import Attrs, Component
- from ludic.html import a
- class LinkAttrs(Attrs):
- to: str
- class Link(Component[str, LinkAttrs]):
- classes = ["link"]
- @override
- def render(self) -> a:
- return a(
- *self.children,
- href=self.attrs["to"],
- style={"color": self.theme.colors.primary},
- )
- ```
- Now you can use it like this:
- ```python
- link = Link("Hello, World!", to="/home")
- ```
- **web.py**:
- ```python
- from ludic.web import LudicApp
- from ludic.html import b, p
- from .components import Link
- app = LudicApp()
- @app.get("/")
- async def homepage() -> p:
- return p(t"Hello {b("Stranger")}! Click {Link("here", to="https://example.com")}!")
- ```
- To run the application:
- ```python
- uvicorn web:app
- ```
- ### Integrations
- Here is a list of integrations and a link to the guide on how to get started:
- * [Starlette](https://getludic.dev/docs/web-framework)
- * [FastAPI](https://getludic.dev/docs/integrations#fastapi)
- * [Django](https://getludic.dev/docs/integrations#django)
- ### More Examples
- For more complex usage incorporating all capabilities of the framework:
- - visit the examples on [getludic.dev](https://getludic.dev/examples)
- - check the folder with examples [on GitHub](https://github.com/getludic/ludic/tree/master/examples/)
- - check the source code of the [Ludic Catalog](https://github.com/getludic/ludic/tree/main/ludic/catalog)
- - inspect the [source of getludic.dev](https://github.com/getludic/web/blob/main/web/endpoints/docs/htmx.py) which is written with Ludic
- - check [this small repository](https://github.com/getludic/ludic-slides/blob/main/ludic_slides/components.py) rendering slides in the browser
- ## Agent Skills
- Ludic ships two agent skills, installable via the [`skills`](https://www.npmjs.com/package/skills) CLI (works with any supported coding agent):
- - [`ludic-components`](skills/ludic-components/SKILL.md) — building components: t-string templating, `Component` / `ComponentStrict` typing, the catalog widgets, htmx attributes, the trusted-vs-untrusted (`Safe`) content boundary.
- - [`ludic-web`](skills/ludic-web/SKILL.md) — building web apps: `LudicApp`, typed `Endpoint` classes, FastAPI / Django integrations, parsers and responses, htmx response patterns, and **safe URL generation (host header poisoning mitigations)**.
- Install one:
- ```bash
- npx skills add https://github.com/getludic/ludic --skill ludic-components
- npx skills add https://github.com/getludic/ludic --skill ludic-web
- ```
- Install both at once:
- ```bash
- npx skills add https://github.com/getludic/ludic --skill ludic-components --skill ludic-web
- # or, equivalently:
- npx skills add https://github.com/getludic/ludic --skill '*'
- ```
- Once installed, the agent will pick the relevant skill up automatically whenever you ask it to write or modify Ludic code.
- ## Contributing
- Any contributions to the framework are warmly welcome! Your help will make it a better resource for the community. If you're ready to contribute, read the [contribution guide](https://github.com/getludic/ludic/tree/master/CONTRIBUTING.md).
- * [GitHub Issues](https://github.com/getludic/ludic/issues) - If you encounter a bug, please report it here.
- * [GitHub Discussions](https://github.com/getludic/ludic/discussions) - To request a new feature, this is the best place to initiate the discussion.
- * [Discord](https://discord.gg/7nK4zAXAYC) - Join our Discord server for support, sharing ideas, and receiving assistance.
Ratings and comments
Sign in to rate this skill.
Sign inFree to use. If it’s helped, pass it on.