README 5.1 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130
  1. $Id: README 2326 2005-03-17 07:45:21Z fredrik $
  2. =======================
  3. The elementtree library
  4. =======================
  5. This kit contains the ElementTree library, a light-weight toolkit for
  6. XML processing in Python.
  7. For more information on this library, see:
  8. docs/index.html
  9. http://effbot.org/zone/element.htm
  10. The modules are designed to work with Python 2.1 and newer. The core
  11. ElementTree module and the SimpleXMLTreeBuilder class also works under
  12. 1.5.2 and 2.0.
  13. Enjoy /F
  14. fredrik@pythonware.com
  15. http://www.pythonware.com
  16. --------------------------------------------------------------------
  17. The ElementTree Library is
  18. Copyright (c) 1999-2005 by Secret Labs AB
  19. Copyright (c) 1999-2005 by Fredrik Lundh
  20. By obtaining, using, and/or copying this software and/or its
  21. associated documentation, you agree that you have read, understood,
  22. and will comply with the following terms and conditions:
  23. Permission to use, copy, modify, and distribute this software and its
  24. associated documentation for any purpose and without fee is hereby
  25. granted, provided that the above copyright notice appears in all
  26. copies, and that both that copyright notice and this permission notice
  27. appear in supporting documentation, and that the name of Secret Labs
  28. AB or the author not be used in advertising or publicity pertaining to
  29. distribution of the software without specific, written prior
  30. permission.
  31. SECRET LABS AB AND THE AUTHOR DISCLAIMS ALL WARRANTIES WITH REGARD TO
  32. THIS SOFTWARE, INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND
  33. FITNESS. IN NO EVENT SHALL SECRET LABS AB OR THE AUTHOR BE LIABLE FOR
  34. ANY SPECIAL, INDIRECT OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
  35. WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
  36. ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT
  37. OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
  38. --------------------------------------------------------------------
  39. release info
  40. ------------
  41. This is release 1.2.6 of the ElementTree library.
  42. For a list of changes in this release, see the CHANGES document.
  43. The latest version of this library can be downloaded from:
  44. http://effbot.org/downloads
  45. Comments, bug reports, and patches are welcome. Send them to
  46. fredrik@pythonware.com.
  47. Note that this is free software, with limited support. If you need
  48. commercial support on this module, contact fredrik@pythonware.com.
  49. --------------------------------------------------------------------
  50. contents
  51. --------------------------------------------------------------------
  52. README This file
  53. CHANGES List of changes in this release.
  54. elementtree/
  55. ElementTree.py Element tree implementation. For a minimal
  56. install, this file is all you need.
  57. ElementPath.py Element path support module. Adds limited
  58. XPath support to find/findtext/findall.
  59. ElementInclude.py Element include support module. Adds limited
  60. XInclude support.
  61. HTMLTreeBuilder.py Element tree builder for HTML. This only
  62. works for mostly well-formed HTML; if you
  63. need something that can parse arbitrary
  64. HTML at least as good as your browser, use
  65. TidyHTMLTreeBuilder or TidyTools (see below).
  66. XMLTreeBuilder.py Element tree builder for XML (compatibility;
  67. new code should use the tree builder in the
  68. ElementTree module).
  69. TidyHTMLTreeBuilder.py Element tree builder for HTML, based on the
  70. tidylib library. This tree builder requires
  71. the _elementtidy extension module (available
  72. from http://effbot.org/downloads).
  73. SimpleXMLTreeBuilder.py Old element tree builder for XML, based on
  74. xmllib, for Python versions where "expat" is
  75. not available. Due to bugs in xmllib, the
  76. namespace support is not reliable (run the
  77. module as a script to find out exactly how
  78. unreliable it is on your Python version...)
  79. SgmlopXMLTreeBuilder.py Simple element tree builder based on the
  80. SGMLOP parser. Note: The current version
  81. does not support namespaces.
  82. SimpleXMLWriter.py Simple XML writer
  83. TidyTools.py Build element trees from HTML, using the
  84. external 'tidy' utility.
  85. setup.py Build/installation script
  86. docs/index.html API reference pages.
  87. docs/*
  88. demo*.py Sample scripts
  89. samples/* Sample data
  90. selftest.py Selftest (requires Python 2.1 or later)
  91. tidytest.py Selftest for TidyHTMLTreeBuilder components.
  92. benchmark.py Benchmark script (usage: benchmark.py file)