Skip to main content

htpy - HTML in Python

Project description

htpy - HTML in Python

htpy is a library that makes writing HTML in plain Python fun and efficient, without a template language.

Define HTML in Python:

from htpy import body, h1, head, html, li, title, ul

menu = ["egg+bacon", "bacon+spam", "eggs+spam"]

print(
    html[
        head[title["Today's menu"]],
        body[
            h1["Menu"],
            ul(".menu")[(li[item] for item in menu)],
        ],
    ]
)

And Get HTML:

<!DOCTYPE html>
<html>
  <head>
    <title>Today's menu</title>
  </head>
  <body>
    <h1>Menu</h1>
    <ul class="menu">
      <li>egg+bacon</li>
      <li>bacon+spam</li>
      <li>eggs+spam</li>
    </ul>
  </body>
</html>

Motivation for This Project

At Personalkollen, where htpy was originally developed we often found ourselves hitting walls when using classic templates. htpy was created to improve the productiveness and experience of generating HTML from a Python backend.

Key Features

  • Leverage static types: Use mypy or pyright to type check your code.

  • Great debugging: Avoid cryptic stack traces from templates. Use your favorite Python debugger.

  • Easy to extend: There is no special way to define template tags/filters. Just call regular functions.

  • Works with existing Python web framework: Works great with Django, Flask or any other Python web framework!

  • Works great with htmx: htpy makes for a great experience when writing server rendered partials/components.

  • Create reusable components: Define components, snippets, complex layouts/pages as regular Python variables or functions.

  • Familiar concepts from React: React helped make it popular writing HTML with a programming language. htpy uses a lot of similar constructs.

Philosophy

htpy generates HTML elements and attributes and provide a few helpers.

htpy does not enforce any particular pattern or style to organize your pages, components and layouts. That does not mean that htpy cannot be used to build sophisticated web pages or applications.

Rather the opposite: you are encouraged the leverage the power of Python to structure your project. Use modules, classes, functions, decorators, list comprehension, generators, conditionals, static typing and any other feature of Python to organize your components. This gives you a lot of power and makes htpy scale from a single small Flask project to bigger applications.

Common patterns can give you some ideas that you can build upon yourself.

The Syntax

Child elements are specified using the [] syntax. This may look strange at first but it has some nice benefits. This clearly separates attributes from child elements and makes the code more readable. It is implemented using the __getitem__ method, just like lists or dicts.

Installation

htpy is available on PyPI. You may install the latest version using pip:

pip install htpy

Documentation

The full documentation is available at htpy.dev:

Project details


Download files

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

Source Distribution

htpy-25.6.2.tar.gz (287.0 kB view details)

Uploaded Source

Built Distribution

htpy-25.6.2-py3-none-any.whl (18.8 kB view details)

Uploaded Python 3

File details

Details for the file htpy-25.6.2.tar.gz.

File metadata

  • Download URL: htpy-25.6.2.tar.gz
  • Upload date:
  • Size: 287.0 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.12.9

File hashes

Hashes for htpy-25.6.2.tar.gz
Algorithm Hash digest
SHA256 3f7332ef1d8020f965123cb36d34ae5bfa40109881297bdaec935f61761a2018
MD5 14673c89b315a977dfe0c15d2149a3a5
BLAKE2b-256 b379739bf6febc2ea394dda6307a3fb79dad4e35e94d1f3f970ff15092d4b56e

See more details on using hashes here.

Provenance

The following attestation bundles were made for htpy-25.6.2.tar.gz:

Publisher: release.yml on pelme/htpy

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

File details

Details for the file htpy-25.6.2-py3-none-any.whl.

File metadata

  • Download URL: htpy-25.6.2-py3-none-any.whl
  • Upload date:
  • Size: 18.8 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.12.9

File hashes

Hashes for htpy-25.6.2-py3-none-any.whl
Algorithm Hash digest
SHA256 25be546ea71bd3bb6bd0c4a9c9f3cd10e6823bc010ab42dd79003d4aa8b556e1
MD5 66637a143f87a4a039a6dc4486cc3474
BLAKE2b-256 a6d2a273a8f0f0c68a6b0df312893426847cdf5b373f6e673561bda0a0c078ae

See more details on using hashes here.

Provenance

The following attestation bundles were made for htpy-25.6.2-py3-none-any.whl:

Publisher: release.yml on pelme/htpy

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 Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page