Easy and quick html builder with natural syntax correspondence (python->html). No templates needed. Serves pure pythonic library with no dependencies.

Project description

Airium

Bidirectional HTML-python translator.

Key features:

simple, straight-forward
template-less (just the python, you may say goodbye to all the templates)
DOM structure is strictly represented by python indentation (with context-managers)
gives much cleaner HTML than regular templates
equipped with reverse translator: HTML to python

Writing `HTML` files using `airium`

Basic `HTML` page (hello world)

from airium import Airium
a = Airium()

a('<!DOCTYPE html>')
with a.html(lang="pl"):
    with a.head():
        a.meta(charset="utf-8")
        a.title(_t="Airium example")

    with a.body():
        with a.h3(id="id23409231", klass='main_header'):
            a("Hello World.")

html = str(a) # casting to string extracts the value

print(html)

Prints such a string:

<!DOCTYPE html>
<html lang="pl">
  <head>
    <meta charset="utf-8" />
    <title>Airium example</title>
  </head>
  <body>
    <h3 id="id23409231" class="main_header">
      Hello World.
    </h3>
  </body>
</html>

In order to store it as a file, just:

with open('that/file/path.html', 'w') as f:
    f.write(str(html))

Simple image in a div

from airium import Airium
a = Airium()

with a.div():
    a.img(src='source.png', alt='alt text')
    a('the text')

html_str = str(a)
print(html_str)

<div>
    <img src="source.png" alt="alt text" />
    the text
</div>

Table

from airium import Airium
a = Airium()

with a.table(id='table_372'):
    with a.tr(klass='header_row'):
        a.th(_t='no.')
        a.th(_t='Firstname')
        a.th(_t='Lastname')

    with a.tr():
        a.td(_t='1.')
        a.td(id='jbl', _t='Jill')
        a.td(_t='Smith')  # can use _t or text

    with a.tr():
        a.td(_t='2.')
        a.td(_t='Roland', id='rmd')
        a.td(_t='Mendel')

table_str = str(a)
print(table_str)

# To store it to a file:
with open('/tmp/airium_www.example.com.py') as f:
    f.write(table_str)

Now table_str contains such a string:

<table id="table_372">
  <tr class="header_row">
    <th>no.</th>
    <th>Firstname</th>
    <th>Lastname</th>
  </tr>
  <tr>
    <td>1.</td>
    <td id="jbl">Jill</td>
    <td>Smith</td>
  </tr>
  <tr>
    <td>2.</td>
    <td id="rmd">Roland</td>
    <td>Mendel</td>
  </tr>
</table>

Chaining shortcut for elements with only one child

New in version 0.2.2

Having a structure with large number of with statements:

from airium import Airium
a = Airium()

with a.article():
    with a.table():
        with a.thead():
            with a.tr():
                a.th(_t='Column 1')
                a.th(_t='Column 2')
        with a.tbody():
            with a.tr():
                with a.td():
                    a.strong(_t='Value 1')
                a.td(_t='Value 2')

table_str = str(a)
print(table_str)

You may use a shortcut that is equivalent to:

from airium import Airium
a = Airium()

with a.article().table():
    with a.thead().tr():
        a.th(_t="Column 1")
        a.th(_t="Column 2")
    with a.tbody().tr():
        a.td().strong(_t="Value 1")
        a.td(_t="Value 2")

table_str = str(a)
print(table_str)

<article>
  <table>
    <thead>
      <tr>
        <th>Column 1</th>
        <th>Column 2</th>
      </tr>
    </thead>
    <tbody>
      <tr>
        <td>
          <strong>Value 1</strong>
        </td>
        <td>Value 2</td>
      </tr>
    </tbody>
  </table>
</article>

Reverse translation

Airium is equipped with a transpiler [HTML -> py]. It generates python code out of a given HTML string.

Using reverse translator as a binary:

Ensure you have installed [parse] extras. Then call in command line:

airium http://www.example.com

That will fetch the document and translate it to python code. The code calls airium statements that reproduce the HTML document given. It may give a clue - how to define HTML structure for a given web page using airium package.

To store the translation's result into a file:

airium http://www.example.com > /tmp/airium_example_com.py

You can also parse local HTML files:

airium /path/to/your_file.html > /tmp/airium_my_file.py

You may also try to parse your Django templates. I'm not sure if it works, but there will be probably not much to fix.

Using reverse translator as python code:

from airium import from_html_to_airium

# assume we have such a page given as a string:
html_str = """\
<!DOCTYPE html>
<html lang="pl">
  <head>
    <meta charset="utf-8" />
    <title>Airium example</title>
  </head>
  <body>
    <h3 id="id23409231" class="main_header">
      Hello World.
    </h3>
  </body>
</html>
"""

# to convert the html into python, just call:

py_str = from_html_to_airium(html_str)

# airium tests ensure that the result of the conversion is equal to the string:
assert py_str == """\
#!/usr/bin/env python
# File generated by reverse AIRIUM translator (version 0.2.2).
# Any change will be overridden on next run.
# flake8: noqa E501 (line too long)

from airium import Airium

a = Airium()

a('<!DOCTYPE html>')
with a.html(lang='pl'):
    with a.head():
        a.meta(charset='utf-8')
        a.title(_t='Airium example')
    with a.body():
        a.h3(klass='main_header', id='id23409231', _t='Hello World.')
"""

Transpiler limitations

so far in version 0.2.2:

result of translation does not keep exact amount of leading whitespaces within <pre> tags. They come over-indented in python code.

This is not however an issue when code is generated from python to HTML.
although it keeps the proper tags structure, the transpiler does not chain all the with statements, so in some cases the generated code may be much indented.
it's not too fast

Installation

If you need a new virtual environment, call:

virtualenv venv
source venv/bin/activate

Having it activated - you may install airium like this:

pip install airium

In order to use reverse translation - two additional packages are needed, run:

pip install airium[parse]

Then check if the transpiler works by calling:

airium --help

Enjoy!

Project details

Release history Release notifications | RSS feed

This version

0.2.2

Jan 31, 2021

0.2.1

Dec 7, 2020

0.2.0

Oct 29, 2020

0.1.6

Sep 20, 2020

0.1.5

Sep 18, 2020

0.1.4

Sep 18, 2020

0.1.3

Sep 18, 2020

0.1.2

Sep 18, 2020

0.1.1

Sep 18, 2020

0.1.0

Sep 18, 2020

0.0.8

Sep 18, 2020

0.0.7

Sep 18, 2020

0.0.6

Sep 18, 2020

0.0.5

Sep 18, 2020

Download files

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

Files for airium, version 0.2.2
Filename, size	File type	Python version	Upload date	Hashes
Filename, size airium-0.2.2-py3-none-any.whl (21.9 kB)	File type Wheel	Python version py3	Upload date Jan 31, 2021	Hashes View
Filename, size airium-0.2.2.tar.gz (15.1 kB)	File type Source	Python version None	Upload date Jan 31, 2021	Hashes View

Hashes for airium-0.2.2-py3-none-any.whl

Hashes for airium-0.2.2-py3-none-any.whl
Algorithm	Hash digest
SHA256	`5157e80a2366fd13bae657fbfe37dca90c5c279961a2772a7eccd4eaa2dea339`
MD5	`946dcf3cad1cd961df638d47f38a7d64`
BLAKE2-256	`e7e9ecaa0da355d645de84798c4aadad04759ab94894da31d3ae4a4620c423c3`

Hashes for airium-0.2.2.tar.gz

Hashes for airium-0.2.2.tar.gz
Algorithm	Hash digest
SHA256	`19015ad991ed226c9998ea3e516a1a77319a8859dab904b73187584c8d9353b6`
MD5	`752e8252a885d1bc733e4e0603671a74`
BLAKE2-256	`2d64755d74f17c943175493689eed7af5b4c4dcb48bc9398c6985bfaec944d74`