1 Introduction
2 ------------
3
4 See docs/index.html for the libxml2dom documentation.
5
6 Contact, Copyright and Licence Information
7 ------------------------------------------
8
9 The current Web page for libxml2dom at the time of release is:
10
11 http://www.boddie.org.uk/python/libxml2dom.html
12
13 Copyright and licence information can be found in the docs directory - see
14 docs/COPYING.txt for more information.
15
16 Dependencies
17 ------------
18
19 libxml2 Tested with libxml2 2.6.17.
20 Use --with-python=<path to python executable> if building from
21 source. Previous releases of libxml2 in the 2.6 series may work,
22 but releases before 2.6.16 are not recommended.
23 Python Tested with Python 2.4.
24 Python releases from 2.2 onwards should be compatible with
25 libxml2dom. The principal requirement from such releases is the
26 new-style class support which permits the use of properties in
27 the libxml2dom implementation.
28
29 Testing
30 -------
31
32 Some of the tests require libxml2macro.py to be run on the test source code
33 first. Read the docstrings for the various test files before attempting to run
34 any of them. See also docs/NOTES_libxml2macro.txt for more information.
35
36 Issues
37 ------
38
39 Use of importNode seems to cause some kind of memory issue, probably related
40 to nodes being shared across documents. This was observed in libxml2 2.6.0 but
41 appears to be fixed in libxml2 2.6.16.
42
43 Even compared to minidom, importNode may seem very slow (even the
44 libxml2dom.macrolib implementation, too). A way is needed to get libxml2 to do
45 the node copying itself.
46
47 New in libxml2dom 0.2.2 (Changes since libxml2dom 0.2.1)
48 --------------------------------------------------------
49
50 * Fixed exception raising in parseURI, adding a docstring to explain the
51 current limitations around HTML parsing.
52
53 New in libxml2dom 0.2.1 (Changes since libxml2dom 0.2)
54 ------------------------------------------------------
55
56 * Moved libxml2macro script to the tools directory.
57 * Added getElementsByTagNameNS.
58 * Added a normalize implementation.
59 * Added HTML parsing support.
60 * Added prettyprinting support.
61 * Fixed parseURI.
62 * Introduced better testing for Unicode objects, especially since things
63 like rdflib like to subclass the unicode type, and it might be more
64 convenient to detect such subclasses and convert their values
65 automatically.
66 * Improved some of the API documentation.
67 * Introduced better suppression of warnings, network access, and other
68 potentially intrusive libxml2 features.
69 * Reorganised the documentation, expanding the README.txt file at the
70 expense of the HTML documentation, but removing older, less relevant
71 information.
72 * Added Debian package support.
73
74 New in libxml2dom 0.2 (Changes since libxml2dom 0.1.3)
75 ------------------------------------------------------
76
77 * Adopted libxml2macro code within the libxml2dom classes, removing any
78 dependencies on the libxml2 module - this makes everything much faster
79 and virtually removes any necessity to use libxml2macro.
80 * Improved attribute and document node handling.
81 * Introduced document reference management.
82 * Introduced NodeList wrapper objects.
83
84 New in libxml2dom 0.1.3 (Changes since libxml2dom 0.1.2)
85 --------------------------------------------------------
86
87 * Fixed createElement.
88 * Introduced experimental libxml2macro tools, tests and libraries.
89
90 New in libxml2dom 0.1.2 (Changes since libxml2dom 0.1.1)
91 --------------------------------------------------------
92
93 * Fixed getAttributeNode and getAttributeNodeNS.
94 * Added comment node creation.
95 * Fixed empty namespace usage with elements and attributes.
96 * Introduced usage of the libxml2 file and memory parsing features.
97 * Introduced suppression of DTD retrieval and validation as the default
98 behaviour.
99 * Added experimental XPath method support.
100
101 New in libxml2dom 0.1.1
102 -----------------------
103
104 * Fixed text node creation.
105 * Fixed setAttributeNS.
106 * Added encoding parameters to convenience methods.
107 * Added the missing previousSibling property.
108 * Added release number to the package.
109
110 Release Procedures
111 ------------------
112
113 Update the libxml2dom/__init__.py and libxml2dom/macrolib/__init__.py
114 __version__ attributes.
115 Change the version number and package filename/directory in the documentation.
116 Change code examples in the documentation if appropriate.
117 Update the release notes (see above).
118 Update the package release notes (in the packages directory).
119 Check the setup.py file and ensure that all package directories are mentioned.
120 Check the release information in the PKG-INFO file and in the package
121 changelog (and other files).
122 Tag, export.
123 Archive, upload.
124 Make packages (see below).
125 Update PyPI, PythonInfo Wiki, Vaults of Parnassus entries.
126
127 Making Packages
128 ---------------
129
130 To make Debian-based packages:
131
132 1. Create new package directories under packages if necessary.
133 2. Make a symbolic link in the distribution's root directory to keep the
134 Debian tools happy:
135
136 ln -s packages/ubuntu-hoary/python2.4-libxml2dom/debian/
137
138 3. Run the package builder:
139
140 dpkg-buildpackage -rfakeroot
141
142 4. Locate and tidy up the packages in the parent directory of the
143 distribution's root directory.