Beautiful HTML/XHTML/XML using YAML
Project description
Yatom
Beautiful HTML/XHTML/XML using YAML.
Yatom is a YAML to markup compiler supporting XML and HTML as output formats.
HTML and its siblings are not friendly at all, their very convoluted and often unreadable nature (due its parent: SGML) cannot be overtaken regardless on how much effort is put on both indentation and formatting. And even that requires further postprocessing to avoid the a huge size overhead.
In some way, Yatom shares the same concept as jedi/pugjs and HAML, but unless being yaml-inspiredTM, Yatom is absolutely pure YAML, completely language agnostic, without extra stuff, requirements or incompatibilities.
YAML in, HTML out, simple.
Usage
Simple HTML5 page using Yatom.
import yatom
source = '''
doctype: html5
html:
head:
title: My Yatom page!
body:
h2: Yatom is awesome
p: >-
Now, you can code your page with
beautiful markup without worrying
about inefficient HTML output nor
erratic linebreak behavior thanks
to Yatom.
'''
print(
yatom.HTMLProcessor
.from_source(source)
.render()
)
<!DOCTYPE html>
<html><head><title>My Yatom page!</title></head><body><h2>Yatom is awesome</h2><p>Now, you can code your page with beautiful markup without worrying about inefficient HTML output nor erratic linebreak behavior thanks to Yatom.</p></body></html>
The Yatom syntax
Yatom uses regular YAML, but that doesn't mean documents can of arbitrary shape.
The YAML document structure is defined by the target language, but mostly all follow the following rules:
- YAML root must be a mapping, as mappings define the document structure.
- If a non-mapping value is is encountered, it is treated as text.
HTML/XHTML/XML
The YAML syntax defining an entire HTML document is quite simple. If you already know HTML you can start writing Yatom templates with very few rules:
- Mapping keys are tag names, with one exception:
- Key
doctypeis handled differently, its accepted values are listed here:- html4-strict
- html4-transitional
- html4-frameset
- html5
- xhtml1-strict
- xhtml1-transitional
- xhtml1-frameset
- xhtml11
- Key
- Mapping string values are treated as text content.
- Dot-prefixed keys are tag attributes and must appear before any other sibling keys, with some exceptions:
- .text for inline text strings (escaped)
- .literal for unescaped inlined text strings (allowing inline markup)
- .cdata for XML CDATA tags
- .comment for HTML comments
In addition to previous rules, attributes support nesting, with the following rules:
- When style value is a mapping, properties are treated as CSS properties, and nested mapping keys are joined with dashes (
-). - When class value is a mapping or list, its properties are treated as different classes (the dot is prefixed). It its a mapping its hierarchy (mapping or array) is combined with dashes (
-). - If any other attribute value is a mapping or list, its hierarchy is combined with dashes (
-).
And as a bonus, and only if required by doctype, few tags provide sane defaults:
- Both html4 and xhtml:
styleelement's attributetypedefaults totext/css.scriptelement's attributetypedefaults toapplication/javascript.
- Only xhtml:
htmlelement has both defaultlangandxmlns.- Both
styleandscriptelement's content is automatically wrapped withCDATAtags.
Semantic HTML rules are applied.
Examples
Simple example for HTML5.
import yatom
source = '''
doctype: html5
html:
head:
title: my page
body:
h2: my page
p: |
multiline
text
p:
.text: mixed
span:
.style:
color: red
.text: tags
.text: and
strong: text
'''
print(
yatom.HTMLProcessor
.from_source(source)
.render()
)
<!DOCTYPE html>
<html><head><title>my page</title></head><body><h2>my page</h2><p>multiline
text
</p><p>mixed<span style="color:red">tags</span>and<strong>text</strong></p></body></html>
More advanced XHTML4 example.
import yatom
source = '''
doctype: xhtml11
html:
head:
title: my page
script: window.alert('<hello world>')
body:
.data:
something: 1
other: 2
.class:
- simple:
- nested
- other
.style:
padding:
top: 2em
bottom: 2em
left: 25%
right: 25%
p: some simple text
'''
print(
yatom.HTMLProcessor
.from_source(source)
.render()
)
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN" "http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en"><head><title>my page</title><script type="application/javascript"><![CDATA[window.alert('<hello world>')]]></script></head><body data-something="1" data-other="2" class="simple-nested other" style="padding-top:2em;padding-bottom:2em;padding-left:25%;padding-right:25%"><p>some simple text</p></body></html>
Roadmap
- Pretty print
- Pluggable templating engines or logic
- Drop python2 for good
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
File details
Details for the file yatom-0.0.4.tar.gz.
File metadata
- Download URL: yatom-0.0.4.tar.gz
- Upload date:
- Size: 12.8 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/1.13.0 pkginfo/1.5.0.1 requests/2.19.1 setuptools/40.8.0 requests-toolbelt/0.9.1 tqdm/4.31.1 CPython/3.7.3
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | b66d0ee8b106ef99fbc13723543de9afb511071a901e4d0304f8573f58e87445 |
|
| MD5 | c2164a4750cdb57e09f6933c83a6136b |
|
| BLAKE2b-256 | 7edca6c2d998f4f47ae372659bed29ebc2900ecf560eb74ab1223bc63d8c5234 |
File details
Details for the file yatom-0.0.4-py2.py3-none-any.whl.
File metadata
- Download URL: yatom-0.0.4-py2.py3-none-any.whl
- Upload date:
- Size: 14.9 kB
- Tags: Python 2, Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/1.13.0 pkginfo/1.5.0.1 requests/2.19.1 setuptools/40.8.0 requests-toolbelt/0.9.1 tqdm/4.31.1 CPython/3.7.3
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 935b5a7a48c9f0d7f452938de3b319264632c9311cf1220288dbfd1e175c01f1 |
|
| MD5 | 511d7ac34ed840c7f4f727547d282417 |
|
| BLAKE2b-256 | 4fdeed64c840812a6a0ef38a9978c97897558d50652220c2d1481fb3b23c5f36 |
