Copyright (c) 2006 The Authors

Contributers:

James Graham - jg307@cam.ac.uk

Anne van Kesteren - annevankesteren@gmail.com

Lachlan Hunt - lachlan.hunt@lachy.id.au

Matt McDonald - kanashii@kanashii.ca

Sam Ruby - rubys@intertwingly.net

Ian Hickson (Google) - ian@hixie.ch

Thomas Broyer - t.broyer@gmail.com

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

html5lib is a pure-python library for parsing HTML. It is designed to

conform to the Web Applications 1.0 specification, which has

formalized the error handling algorithms of popular web browsers.

= Installation =

html5lib is packaged with distutils. To install it use:

$ python setup.py install

= Tests =

You may wish to check that your installation has been a success by

running the testsuite. All the tests can be run by invoking

runtests.py in the tests/ directory

= Usage =

Simple usage follows this pattern:

import html5lib

f = open("mydocument.html")

parser = html5lib.HTMLParser()

document = parser.parse(f)

The returned document is a simple DOM-like structure which can be

navigated using the .parent and .childNode attributes on each

element. Future releases will support a more substantial tree

implementation.

More documentation is avaliable in the docstrings.

= Bugs =

Please report any bugs on the issue tracker:

http://code.google.com/p/html5lib/issues/list

= Get Involved =

Contributions to code or documenation are actively encouraged. Submit

patches to the issue tracker or discuss changes on irc in the #whatwg

channel on freenode.net