Skip to main content

DSL for writing HTML user interfaces in Python.

Project description

Aether

Build HTML user interfaces in Python.

Introduction

Aether is a DSL that lets you build HTML components as Python objects, offering a clean, component-based approach that avoids the complexities of traditional templating engines. Create reusable components that generate HTML fragments to build complex views, pages, or even entire web applications, all within your Python workflow.

Getting Started

Installation:

pip install pyaether  

Simple Example:

from aether.tags.html import H1, Div, P
from aether import render

page = Div(_class="container")(
    H1()("My Awesome Page"),
    P()("This is a paragraph of text.")
)

print(render(page))

This will output neatly formatted HTML.

Advanced Example 1: Dynamic Content and Components

from aether.tags.html import Li, Span, Ul
from aether import render

items = ["apple", "banana", "cherry"]
item_list = Ul()(Li()(item) for item in items)

name = "Alice"
greeting = Span()(f"Hello, {name}!")

print(render(Div()(greeting, item_list)))

This demonstrates creating dynamic content and nesting components. The output will be an HTML <div> containing a greeting and the unordered list of fruits.

Advanced Example 2: HTMX Support

from aether.tags.html import Div, Button, Img
from aether import render

click_to_load = Div(id="replace_me")(
    Button(
        _class="btn primary",
        hx_get="/example/?data=1",
        hx_target="#replace_me",
        hx_swap="outerHTML",
    )(
        "Load More Data...",
        Img(_class="htmx-indicator", src="/img/bars.svg", alt="Loading..."),
    )
)

print(render(click_to_load))

Backwards Compatibility Note

This project is under active development and has not yet reached v1.0.0. This means that while we are working hard to build the best possible package, we may need to make changes that affect how your code works.

Version Stability:

  • Minor Version Updates (e.g., 0.1.x -> 0.2.x): These updates may introduce breaking changes as we refine and improve the package's functionality and APIs.
  • Patch Version Updates (e.g., 0.1.1 -> 0.1.2): These updates will maintain compatibility within the same minor version and generally include bug fixes or small enhancements.

To avoid unexpected disruptions, it is recommended to pin your dependency to a specific minor version (v0.x) and carefully review release notes before upgrading to a new minor version.

We appreciate your understanding and welcome feedback as we work towards a stable and robust v1.0.0!

License

This project is licensed under the BSD-2-Clause License

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

pyaether-0.4.3.tar.gz (65.6 kB view details)

Uploaded Source

Built Distribution

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

pyaether-0.4.3-py3-none-any.whl (109.3 kB view details)

Uploaded Python 3

File details

Details for the file pyaether-0.4.3.tar.gz.

File metadata

  • Download URL: pyaether-0.4.3.tar.gz
  • Upload date:
  • Size: 65.6 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: uv/0.7.20

File hashes

Hashes for pyaether-0.4.3.tar.gz
Algorithm Hash digest
SHA256 48409ba8a70fb9d1dddf42e44eee55035b04d988de1e25e53beefe1706dde2c7
MD5 6cebfc0ef0e08d728a19d16e5dc54453
BLAKE2b-256 02706ec9e261ca7714224513036849074c3e34e38ab7ab91b5373fa03c96e5b8

See more details on using hashes here.

File details

Details for the file pyaether-0.4.3-py3-none-any.whl.

File metadata

  • Download URL: pyaether-0.4.3-py3-none-any.whl
  • Upload date:
  • Size: 109.3 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: uv/0.7.20

File hashes

Hashes for pyaether-0.4.3-py3-none-any.whl
Algorithm Hash digest
SHA256 49fc650b12d11de1b2988693747f3940a50d3bb28d2be919ebf4596715b192ae
MD5 662974e4a5d139dd5ab272a2330155f5
BLAKE2b-256 7f185be0c65f2d3fb1a7b0cc3452cb7f661983fde83330fd021cf3b8107efb1f

See more details on using hashes here.

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