haitch 0.15.0

simplify your HTML building.

simplify your HTML building.

haitch

alternative pronunciation for the letter "H"

My goal is to make writing HTML as fun as writing Python.

Features

• HTML element builder.
• 100% test and type coverage.
• No dependencies.
• Documentation for common elements.

Quickstart

Install haitch using pip:

$ pip install haitch

Importing the package like so, allows you to build any element you like:

import haitch as H

# Render known `h1` tag.
print(H.h1("Hello, world"))
# <h1>Hello, world</h1>

# Render custom `foo` tag (useful for web components).
print(H.foo("Hello, world"))
# <foo>Hello, world!</foo>

# Fetch emails from data store.
emails = ["[e-mail]", "[e-mail]", "[e-mail]"]

# Build an ordered list of emails with ".com" domains.
email_list = H.ol(class_="emails")(
    H.li(H.a(href=f"mailto:{email}")(email))
    for email in sorted(emails)
    if email.endswith(".com")
)

print(email_list)
# <ol class="email-list">
#   <li>
#     <a href="mailto:[e-mail]">[e-mail]</a>
#   </li>
#   <li>
#     <a href="mailto:[e-mail]">[e-mail]</a>
#   </li>
# </ol>

Note: printed output above is prettified for readability, but the actual output is minified.

If you want to see how you can hook haitch into your web application, see the FastAPI and Django examples.

Motivation

Inspired by the htbuilder library as an alternative to templating. The library met most of my needs, but lacked type annotations and documentation for HTML elements and attributes. This made me consistently context switch between the MDN docs and my editor. This library attempts to solve this problem by bringing the HTML spec to where you program.

Non-goals

The following features will not be supported:

• Deprecated elements and attributes: if you want to use them, you can since haitch supports generic elements and attributes. However, I am not going to write the annotations and documentation for them.
• 100% input validation: this library is meant to assist the developer to write valid HTML with the help of type annotations and documentation. In the end, it is up to the developer and browser to verify that the input is of the correct type. So for example, I will not add any validation to make sure that a <col> element is directly nested inside of a <colgroup> element or that the span attribute for the <col> element is a positive integer.

Contributing

• issue tracker: issues for bugs and features.
• mailing list: discussion, announcements, and patches.

You can setup your local git clone to send email to the mailing list with:

git config sendemail.to '~loges/[e-mail]'

Additional help for setting up git send-email.

License

haitch is distributed under the terms of the BSD-3-Clause license and adheres to the REUSE Specification.