Metadata-Version: 2.0
Name: htmlgen
Version: 0.99.1
Summary: HTML 5 Generator
Home-page: https://github.com/srittau/python-htmlgen
Author: Sebastian Rittau
Author-email: srittau@rittau.biz
License: MIT
Description-Content-Type: UNKNOWN
Platform: UNKNOWN
Classifier: Development Status :: 4 - Beta
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python :: 2
Classifier: Programming Language :: Python :: 2.7
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.4
Classifier: Programming Language :: Python :: 3.5
Classifier: Programming Language :: Python :: 3.6
Classifier: Topic :: Internet :: WWW/HTTP :: WSGI
Classifier: Topic :: Text Processing :: Markup :: HTML
Requires-Python: >=2.7, !=3.0.*, !=3.1.*, !=3.2.*, !=3.3.*

Python HTML 5 Generator
=======================

.. image:: https://img.shields.io/pypi/l/htmlgen.svg
   :target: https://pypi.python.org/pypi/htmlgen/
.. image:: https://img.shields.io/github/release/srittau/python-htmlgen/all.svg
   :target: https://github.com/srittau/python-htmlgen/releases/
.. image:: https://img.shields.io/pypi/v/htmlgen.svg
   :target: https://pypi.python.org/pypi/htmlgen/
.. image:: https://travis-ci.org/srittau/python-htmlgen.svg?branch=master
   :target: https://travis-ci.org/srittau/python-htmlgen

Library to generate HTML from classes.

Basic usage:

>>> from htmlgen import Division, Span
>>> Division("This is ", Span("important!"), "!")

A more verbose example:

>>> span = Span("important")
>>> span.add_css_classes("important")
>>> div = Division()
>>> div.id = "my-block"
>>> div.append("This is ")
>>> div.append(span)
>>> div.append("!")

A tree constructed like this can be converted to a string:

>>> str(div)
'<div id="my-block">This is <span class="important">important</span>!</div>'
>>> "<p>This is {}!</p>".format(span)
'<p>This is <span class="important">important</span>!</p>'

Alternatively, all elements can be used as iterators, for example to return
them from a WSGI callback:

>>> def application(env, start_response):
...     start_response("200 OK", [("Content-Type", "text/html")])
...     return div

There are two different ways to render children of HTML elements. The tree
construction approach shown above is mainly suitable for elements with few
children. The disadvantage of this approach is that the whole tree must be
constructed in memory. An alternative way, best suited for custom sub-classes
of elements, is to override the generate_children method of the Element class:

>>> class MyBlock(Division):
...     def __init__(self):
...         super(MyBlock, self).__init__()
...         self.id = "my-block"
...     def generate_children(self):
...         yield "This is "
...         span = Span("important")
...         span.add_css_classes("important")
...         yield span
...         yield "!"
>>> str(MyBlock())
'<div id="my-block">This is <span class="important">important</span>!</div>'


