{
"info": {
"author": "Tom Flanagan and Jake Wharton",
"author_email": "tom@zkpq.ca",
"bugtrack_url": null,
"classifiers": [
"Intended Audience :: Developers",
"License :: OSI Approved :: GNU Lesser General Public License v3 (LGPLv3)",
"Operating System :: OS Independent",
"Programming Language :: Python",
"Programming Language :: Python :: 2",
"Programming Language :: Python :: 2.7",
"Programming Language :: Python :: 3",
"Programming Language :: Python :: 3.4",
"Programming Language :: Python :: 3.5",
"Programming Language :: Python :: 3.6",
"Programming Language :: Python :: 3.7",
"Programming Language :: Python :: Implementation :: PyPy",
"Topic :: Internet :: WWW/HTTP :: Dynamic Content",
"Topic :: Software Development :: Libraries :: Python Modules",
"Topic :: Text Processing :: Markup :: HTML"
],
"description": "Dominate\n========\n\n`Dominate` is a Python library for creating and manipulating HTML documents using an elegant DOM API.\nIt allows you to write HTML pages in pure Python very concisely, which eliminates the need to learn another template language, and lets you take advantage of the more powerful features of Python.\n\n\n[](https://travis-ci.org/Knio/dominate)\n[](https://coveralls.io/r/Knio/dominate?branch=master)\n\nPython:\n\n```python\nimport dominate\nfrom dominate.tags import *\n\ndoc = dominate.document(title='Dominate your HTML')\n\nwith doc.head:\n link(rel='stylesheet', href='style.css')\n script(type='text/javascript', src='script.js')\n\nwith doc:\n with div(id='header').add(ol()):\n for i in ['home', 'about', 'contact']:\n li(a(i.title(), href='/%s.html' % i))\n\n with div():\n attr(cls='body')\n p('Lorem ipsum..')\n\nprint(doc)\n```\n\nOutput:\n\n```html\n\n\n \n Dominate your HTML\n \n \n \n \n
\n \n\n```\n\n\nInstallation\n------------\n\nThe recommended way to install `dominate` is with\n[`pip`](http://pypi.python.org/pypi/pip/):\n\n sudo pip install dominate\n\n[](https://pypi.org/project/dominate/)\n[](https://pypi.org/project/dominate/)\n\n\n\nDeveloped By\n------------\n\n* Tom Flanagan - \n* Jake Wharton - \n* [Brad Janke](//github.com/bradj)\n\nGit repository located at\n[github.com/Knio/dominate](//github.com/Knio/dominate)\n\n\nExamples\n========\n\nAll examples assume you have imported the appropriate tags or entire tag set:\n\n```python\nfrom dominate.tags import *\n```\n\n\nHello, World!\n-------------\n\nThe most basic feature of `dominate` exposes a class for each HTML element, where the constructor\naccepts child elements, text, or keyword attributes. `dominate` nodes return their HTML representation\nfrom the `__str__`, `__unicode__`, and `render()` methods.\n\n```python\nprint(html(body(h1('Hello, World!'))))\n```\n```html\n\n \n
Hello, World!
\n \n\n```\n\nAttributes\n----------\n\n`Dominate` can also use keyword arguments to append attributes onto your tags. Most of the attributes are a direct copy from the HTML spec with a few variations.\n\nFor attributes `class` and `for` which conflict with Python's [reserved keywords](http://docs.python.org/2/reference/lexical_analysis.html#keywords \"Reserved Keywords\"), you can use the following aliases:\n\n| class | for |\n|-------|-----|\n|_class | _for |\n|cls | fr |\n|className|htmlFor|\n|class_name|html_for|\n\n\n```python\ntest = label(cls='classname anothername', fr='someinput')\nprint(test)\n```\n```html\n\n```\n\nUse `data_*` for [custom HTML5 data attributes](http://www.w3.org/html/wg/drafts/html/master/dom.html#embedding-custom-non-visible-data-with-the-data-*-attributes \"HTML5 Data Attributes\").\n\n```python\ntest = div(data_employee='101011')\nprint(test)\n```\n```html\n\n```\n\nYou can also modify the attributes of tags through a dictionary-like interface:\n\n```python\nheader = div()\nheader['id'] = 'header'\nprint(header)\n```\n```html\n\n```\n\nComplex Structures\n------------------\n\nThrough the use of the `+=` operator and the `.add()` method you can easily create more advanced structures.\n\nCreate a simple list:\n\n```python\nlist = ul()\nfor item in range(4):\n list += li('Item #', item)\nprint(list)\n```\n```html\n
\n
Item #0
\n
Item #1
\n
Item #2
\n
Item #3
\n
\n```\n\n`dominate` supports iterables to help streamline your code:\n\n```python\nprint(ul(li(a(name, href=link), __pretty=False) for name, link in menu_items))\n```\n```html\n
\n```\n\nA simple document tree:\n\n```python\n_html = html()\n_body = _html.add(body())\nheader = _body.add(div(id='header'))\ncontent = _body.add(div(id='content'))\nfooter = _body.add(div(id='footer'))\nprint(_html)\n```\n```html\n\n \n \n \n \n \n\n```\n\nFor clean code, the `.add()` method returns children in tuples. The above example can be cleaned up and expanded like this:\n\n```python\n_html = html()\n_head, _body = _html.add(head(title('Simple Document Tree')), body())\nnames = ['header', 'content', 'footer']\nheader, content, footer = _body.add([div(id=name) for name in names])\nprint(_html)\n```\n```html\n\n \n Simple Document Tree\n \n \n \n \n \n \n\n```\n\nYou can modify the attributes of tags through a dictionary-like interface:\n\n```python\nheader = div()\nheader['id'] = 'header'\nprint(header)\n```\n```html\n\n```\n\nOr the children of a tag though an array-line interface:\n\n```python\nheader = div('Test')\nheader[0] = 'Hello World'\nprint(header)\n```\n```html\n
Hello World
\n```\n\nComments can be created using objects too!\n\n```python\nprint(comment('BEGIN HEADER'))\n```\n```html\n\n```\n\n```python\nprint(comment(p('Upgrade to newer IE!'), condition='lt IE9'))\n```\n```html\n\n```\n\nRendering\n---------\n\nBy default, `render()` tries to make all output human readable, with one HTML\nelement per line and two spaces of indentation.\n\nThis behavior can be controlled by the `__pretty` (default: `True` except for\ncertain element types like `pre`) attribute when creating an element, and by\nthe `pretty` (default: `True`), `indent` (default: ` `) and `xhtml` (default: `False`)\n arguments to `render()`. Rendering options propagate to all descendant nodes.\n\n```python\na = div(span('Hello World'))\nprint(a.render())\n```\n```html\n
\n```\n\n\nContext Managers\n----------------\n\nYou can also add child elements using Python's `with` statement:\n\n```python\nh = ul()\nwith h:\n li('One')\n li('Two')\n li('Three')\n\nprint(h)\n```\n```html\n
\n
One
\n
Two
\n
Three
\n
\n```\n\n\nYou can use this along with the other mechanisms of adding children elements, including nesting `with` statements, and it works as expected:\n\n```python\nh = html()\nwith h.add(body()).add(div(id='content')):\n h1('Hello World!')\n p('Lorem ipsum ...')\n with table().add(tbody()):\n l = tr()\n l += td('One')\n l.add(td('Two'))\n with l:\n td('Three')\n\nprint(h)\n```\n```html\n\n \n
\n
Hello World!
\n
Lorem ipsum ...
\n
\n \n
\n
One
\n
Two
\n
Three
\n
\n \n
\n
\n \n\n```\n\nWhen the context is closed, any nodes that were not already added to something get added to the current context.\n\nAttributes can be added to the current context with the `attr` function:\n\n```python\nd = div()\nwith d:\n attr(id='header')\n\n print(d)\n ```\n ```html\n\n```\n\nAnd text nodes can be added with the `dominate.util.text` function:\n\n```python\nfrom dominate.util import text\npara = p(__pretty=False)\nwith para:\n text('Have a look at our ')\n a('other products', href='/products')\n\nprint(para)\n```\n```html\n
\n```\n\n\nDecorators\n----------\n\n`Dominate` is great for creating reusable widgets for parts of your page. Consider this example:\n\n```python\ndef greeting(name):\n with div() as d:\n p('Hello, %s' % name)\n return d\n\nprint(greeting('Bob'))\n```\n```html\n
\n
Hello, Bob
\n
\n```\n\nYou can see the following pattern being repeated here:\n\n```python\ndef widget(parameters):\n with tag() as t:\n ...\n return t\n```\n\nThis boilerplate can be avoided by using tags (objects and instances) as decorators\n\n```python\n@div\ndef greeting(name):\n p('Hello %s' % name)\nprint(greeting('Bob'))\n```\n```html\n
\n
Hello Bob
\n
\n```\n\nThe decorated function will return a new instance of the tag used to decorate it, and execute in a `with` context which will collect all the nodes created inside it.\n\nYou can also use instances of tags as decorators, if you need to add attributes or other data to the root node of the widget.\nEach call to the decorated function will return a copy of the node used to decorate it.\n\n```python\n@div(h2('Welcome'), cls='greeting')\ndef greeting(name):\n p('Hello %s' % name)\n\nprint(greeting('Bob'))\n```\n```html\n\n
\n
Welcome
\n
Hello Bob
\n
\n```\n\nCreating Documents\n------------------\n\nSince creating the common structure of an HTML document everytime would be excessively tedious dominate provides a class to create and manage them for you: `document`.\n\nWhen you create a new document, the basic HTML tag structure is created for you.\n\n```python\nd = document()\nprint(d)\n```\n```html\n\n\n \n Dominate\n \n \n\n```\n\nThe `document` class accepts `title`, `doctype`, and `request` keyword arguments.\nThe default values for these arguments are `Dominate`, ``, and `None` respectively.\n\nThe `document` class also provides helpers to allow you to access the `title`, `head`, and `body` nodes directly.\n\n```python\nd = document()\n```\n\n```python\n>>> d.head\n\n>>> d.body\n\n>>> d.title\nu'Dominate'\n```\n\n\nThe `document` class also provides helpers to allow you to directly add nodes to the `body` tag.\n\n```python\nd = document()\nd += h1('Hello, World!')\nd += p('This is a paragraph.')\nprint(d)\n```\n```html\n\n\n \n Dominate\n \n \n