Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with
or
.
Download ZIP
Fetching contributors…

Cannot retrieve contributors at this time

172 lines (123 sloc) 5.957 kB
lxml
====
Introduction
------------
lxml is a Pythonic binding for the libxml2_ and libxslt_ libraries. See the
introduction_ for more information about background and goals. Some common
questions are answered in the FAQ_.
.. _libxml2: http://xmlsoft.org
.. _libxslt: http://xmlsoft.org/XSLT
.. _introduction: intro.html
.. _FAQ: FAQ.html
Download
--------
The best way to download binary versions is to visit `lxml at the Python
cheeseshop`_. It has the source, eggs and installers for various platforms.
The source distribution is signed with `this key`_.
.. _`lxml at the Python cheeseshop`: http://cheeseshop.python.org/pypi/lxml/
.. _`this key`: pubkey.asc
Please take a look at the `installation instructions`_!
.. _`installation instructions`: installation.html
* `lxml 1.1.2`_, released 2006-10-30 (`changes for 1.1.2`_)
* `lxml 1.1.1`_, released 2006-09-21 (`changes for 1.1.1`_)
* `lxml 1.1`_, released 2006-09-13 (`changes for 1.1`_)
* `lxml 1.0.4`_, released 2006-09-09 (`changes for 1.0.4`_)
* `lxml 1.0.3`_, released 2006-08-08 (`changes for 1.0.3`_)
* `lxml 1.0.2`_, released 2006-06-27 (`changes for 1.0.2`_)
* `lxml 1.0.1`_, released 2006-06-09 (`changes for 1.0.1`_)
* `lxml 1.0`_, released 2006-06-01 (`changes for 1.0`_)
* `lxml 0.9.2`_, released 2006-05-10 (`changes for 0.9.2`_)
* `lxml 0.9.1`_, released 2006-03-30 (`changes for 0.9.1`_)
* `lxml 0.9`_, released 2006-03-20 (`changes for 0.9`_)
* `lxml 0.8`_, released 2005-11-03 (`changes for 0.8`_)
* `lxml 0.7`_, released 2005-06-15 (`changes for 0.7`_)
* `lxml 0.6`_, released 2005-05-14 (`changes for 0.6`_)
* `lxml 0.5.1`_, released 2005-04-09 (`changes for 0.5.1`_)
* `lxml 0.5`_, released 2005-04-08
.. _`lxml 1.1.2`: lxml-1.1.2.tgz
.. _`lxml 1.1.1`: lxml-1.1.1.tgz
.. _`lxml 1.1`: lxml-1.1.tgz
.. _`lxml 1.0.4`: lxml-1.0.4.tgz
.. _`lxml 1.0.3`: lxml-1.0.3.tgz
.. _`lxml 1.0.2`: lxml-1.0.2.tgz
.. _`lxml 1.0.1`: lxml-1.0.1.tgz
.. _`lxml 1.0`: lxml-1.0.tgz
.. _`lxml 0.9.2`: lxml-0.9.2.tgz
.. _`lxml 0.9.1`: lxml-0.9.1.tgz
.. _`lxml 0.9`: lxml-0.9.tgz
.. _`lxml 0.8`: lxml-0.8.tgz
.. _`lxml 0.7`: lxml-0.7.tgz
.. _`lxml 0.6`: lxml-0.6.tgz
.. _`lxml 0.5.1`: lxml-0.5.1.tgz
.. _`lxml 0.5`: lxml-0.5.tgz
.. _`CHANGES for 1.1.2`: changes-1.1.2.html
.. _`CHANGES for 1.1.1`: changes-1.1.1.html
.. _`CHANGES for 1.1`: changes-1.1.html
.. _`CHANGES for 1.0.4`: changes-1.0.4.html
.. _`CHANGES for 1.0.3`: changes-1.0.3.html
.. _`CHANGES for 1.0.2`: changes-1.0.2.html
.. _`CHANGES for 1.0.1`: changes-1.0.1.html
.. _`CHANGES for 1.0`: changes-1.0.html
.. _`CHANGES for 0.9.2`: changes-0.9.2.html
.. _`CHANGES for 0.9.1`: changes-0.9.1.html
.. _`CHANGES for 0.9`: changes-0.9.html
.. _`CHANGES for 0.8`: changes-0.8.html
.. _`CHANGES for 0.7`: changes-0.7.html
.. _`CHANGES for 0.6`: changes-0.6.html
.. _`CHANGES for 0.5.1`: changes-0.5.1.html
It's also possible to check out the latest development version of lxml
from svn directly, using a command like this::
svn co http://codespeak.net/svn/lxml/trunk lxml
You can also `browse it through the web`_. Please read `how to build lxml
from source`_ first. The `latest CHANGES`_ of the developer version are also
accessible. You can check there if a bug you found has been fixed or a
feature you want has been implemented in the latest trunk version.
.. _`how to build lxml from source`: build.html
.. _`browse it through the web`: http://codespeak.net/svn/lxml
.. _`latest CHANGES`: http://codespeak.net/svn/lxml/trunk/CHANGES.txt
Documentation
-------------
lxml.etree follows the ElementTree_ API as much as possible, building it on
top of the native libxml2 tree. See also the `ElementTree compatibility
overview`_ and the `benchmark results`_ comparing lxml to the original
ElementTree_ and cElementTree_ implementations.
Right after the ElementTree_ documentation, the most important place to look
is the `lxml.etree API documentation`_. It describes how lxml extends the
ElementTree API to expose libxml2 and libxslt specific functionality, such as
XPath_, `Relax NG`_, `XML Schema`_, `XSLT`_, and `c14n`_. Python code can be
called from XPath expressions and XSLT stylesheets through the use of
`extension functions`_. lxml also offers a `SAX compliant API`_, that works
with the SAX support in the standard library.
There is a separate module `lxml.objectify`_ that implements a data-binding
API on top of lxml.etree. See the `objectify and etree`_ FAQ entry for a
comparison.
In addition to the ElementTree API, lxml also features a sophisticated API for
`custom element classes`_. This is a simple way to write arbitrary XML driven
APIs on top of lxml. As of version 1.1, lxml.etree has a new `C-level API`_
that can be used to efficiently extend lxml.etree in external C modules,
including custom element class support.
.. _ElementTree: http://effbot.org/zone/element-index.htm
.. _cElementTree: http://effbot.org/zone/celementtree.htm
.. _`benchmark results`: performance.html
.. _`ElementTree compatibility overview`: compatibility.html
.. _`lxml.etree API documentation`: api.html
.. _`extension functions`: extensions.html
.. _`custom element classes`: element_classes.html
.. _`SAX compliant API`: sax.html
.. _`C-level API`: capi.html
.. _`lxml.objectify`: objectify.html
.. _`objectify and etree`: FAQ.html#what-is-the-difference-between-lxml-etree-and-lxml-objectify
.. _XPath: http://www.w3.org/TR/xpath
.. _`Relax NG`: http://www.relaxng.org/
.. _`XML Schema`: http://www.w3.org/XML/Schema
.. _`XSLT`: http://www.w3.org/TR/xslt
.. _`c14n`: http://www.w3.org/TR/xml-c14n
Mailing list
------------
Questions? Suggestions? Code to contribute? We have a `mailing list`_.
.. _`mailing list`: http://codespeak.net/mailman/listinfo/lxml-dev
License
-------
The lxml library is shipped under a BSD license. libxml2 and libxslt2
itself are shipped under the MIT license. There should therefore be no
obstacle to using lxml in your codebase.
Jump to Line
Something went wrong with that request. Please try again.