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!

  • Full async support: Render HTML fully async with ASGI frameworks such as Starlette and FastAPI.

  • 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-26.5.1.tar.gz (292.0 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

htpy-26.5.1-py3-none-any.whl (21.4 kB view details)

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for htpy-26.5.1.tar.gz
Algorithm Hash digest
SHA256 43a365c1fc670094da781b923883019339cec031397d61d5fe5f8e2f2278b63e
MD5 38db5f015894c564e9128667052a98bf
BLAKE2b-256 d31848b0fe5f7b23c8bb0b45b09c306f511417fee74afc49a0765178d6dcbac2

See more details on using hashes here.

Provenance

The following attestation bundles were made for htpy-26.5.1.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-26.5.1-py3-none-any.whl.

File metadata

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

File hashes

Hashes for htpy-26.5.1-py3-none-any.whl
Algorithm Hash digest
SHA256 148566db9d720c897baa5832e2a496954ce317ab06ef49a103b44f8a15322c3b
MD5 d1588f18ddae1d482ff2a5a592fe6381
BLAKE2b-256 e768ad12d6519ccc48852ebb1effbe5a160ff21d7b48c484d0dae6fd173f6d22

See more details on using hashes here.

Provenance

The following attestation bundles were made for htpy-26.5.1-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 Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page