Housekeeping & version management

Thanks to an external contribution I update this project. Good!
So now `xmlunittest` will be tested with `tox`, and still support Python 2.7 and 3.4.
However, no support for older version of Python (no 2.6, no 3.3, etc.).
Also, Python 2.7 works fine with lxml 2.3.x, but not Python 3.4. So, technically, it "works" with lxml 2.3.x, but to play safe, I prefer to say "only lxml 3.x and above".

Ah, and thanks to @metamatik I now use the gender-neutral "their/them" in the documentation - I hope I didn't miss one!

And version 0.3.1, too.

Author: Exirel

README.rst

@@ -35,7 +35,7 @@ Links
 How to
 ======
 
-- Extends xmlunittest.XmlTestCase
+- Extends ``xmlunittest.XmlTestCase``
 - Write your tests, using the function or method that generate XML document
 - Use xmlunittest.XmlTestCase‘s assertion methods to validate
 - Keep your test readable
@@ -66,13 +66,3 @@ Example:
             # Check
             self.assertXpathsUniqueValue(root, ('./leaf@id', ))
             self.assertXpathValues(root, './leaf@active', ('on', 'off'))
-
-
-Running the tests
-======
-
-To run the unit tests for this package::
-
-
-    pip install tox
-    tox

doc/index.rst

@@ -42,9 +42,8 @@ Compatibility
 
 Python ``xmlunittest`` has been tested with:
 
-* ``lxml`` version 3.4.0
+* ``lxml`` version 3.0 and 3.4.
 * Python 2.7.6
-* Python 3.3.0
 * Python 3.4.0
 
 Be aware: as a lot of string manipulation is involved, a lot of issues can
@@ -56,6 +55,27 @@ a Py2/Py3 compatible library.
    Python 2.7.6 support is maintained for now, but it will be eventually
    dropped. It's never too late to switch to Python 3!
 
+LXML version 2.x or 3.x?
+------------------------
+
+When dealing with version number, it appears that ``xmlunittest`` works with:
+
+* Python 2.7 and lxml 2.3.5 and above.
+* Pytonn 3.4 and lmxl 3.0 and above.
+
+.. warning::
+
+   No, ``xmlunittest`` **does not work** with Python 3 and an older version of
+   lxml < 3.0. Also, note that this package is only tested with lxml >= 3.0.
+   It works, but without warranty.
+
+Why not Python 3.3?
+-------------------
+
+This package works with Python 2.7, but it's only because we are lucky enough.
+This is a small project, and it does not aim to support more than one major
+version of python. The latest, the better!
+
 
 How to
 ======
@@ -93,7 +113,7 @@ Example::
 
 
 Alternativly, one can use the :py:class:`XmlTestMixin` instead of the
-:py:class:`XmlTestCase`, as long as its own class also extends
+:py:class:`XmlTestCase`, as long as their own class also extends
 :py:class:`unittest.TestCase`.
 
 This is convenient when there is already a subclass of
@@ -134,8 +154,8 @@ and again? If it is related only to XML tests, maybe you can share it?
 
 First, you can fork the `project's github repository`__, then you will need
 some tools for development: all dependencies are available into the
-``requirements.txt`` file. You should also use a virtualenv (in fact two, one
-per python version).
+``requirements.txt`` file. You should also use a virtualenv (use two for each
+version, or use tox).
 
 See an example of install (without virtualenv)::
 
@@ -147,13 +167,32 @@ See an example of install (without virtualenv)::
 
 .. __: https://github.com/Exirel/python-xmlunittest
 
+.. note::
+
+   Installing lxml is not easy if you are not prepared. You will need some
+   extra source package on your favorite OS (in particular some XML libs and
+   python sources).
+
+
+Testing with tox
+----------------
+
+Now that ``xmlunittest`` uses `tox`__ to run the tests, it's even easier to
+perform tests on multiple version of python. Instead of using ``py.test`` do::
+
+   $ tox test
+
+And that's all! **Remember: Python 2.7 and Python 3.4. Nothing more.**
+
+.. __: https://tox.readthedocs.org/en/latest/
+
 Tips
 ----
 
 **Do**:
 
-* Always tests with both Python 2.7, Python 3.3 and Python 3.4.
-* Always tests with namespaces
+* Always test with both Python 2.7 and Python 3.4 - use Tox!
+* Always test with namespaces
 * Always provide unit-tests.
 * Always provide documentation.
 * It's better to respect PEP8.
@@ -162,7 +201,7 @@ Tips
 
 * Never add any other library. ``xmlunittest`` uses ``lxml`` and that's enough!
 * If you have to add a ``data.encode(charset)`` into an assert method, it's
-  probably not be a good idea.
+  probably not a good idea.
 * XML documents can not be compared as simple strings. Don't compare them
-  as simple string. Don't.
-* Don't write more than 80 characters per line. Please. Don't.
+  as simple string. **Don't.**
+* Don't write more than 80 characters per line. Please. **Don't.**

doc/xmlunittest.rst

@@ -67,7 +67,7 @@ Document assertions
 
    :param string root_tag: Optional, root element's tag name
 
-   One can provide the root element's tag name to the method for his own
+   One can provide the root element's tag name to the method for their own
    convenience.
 
    .. rubric:: Example
@@ -494,20 +494,20 @@ your own schema objects in these various schema languages.
 XML documents comparison assertion
 ==================================
 
-Sometimes, one may want to check a global XML document, because he know exactly
-what is expected, and can rely on a kind of "string compare". Of course, XML
-is not a simple string, and requires more than just an
+Sometimes, one may want to check a global XML document, because they know
+exactly what is expected, and can rely on a kind of "string compare". Of
+course, XML is not a simple string, and requires more than just an
 ``assert data == expected``, because order of elements can vary, order of
-attributes, etc.
+attributes too, namespaces can come into play, etc.
 
 In these cases, one can use the powerful - also dangerous - feature of `LXML
 Output Checker`. See also the documentation of the module
 `doctestcompare <http://lxml.de/api/lxml.doctestcompare-module.html>`_ for
 more information on the underlying implementation.
 
 And as always, remember that the whole purpose of this :py:mod:`xmlunittest`
-is to **not** compare XML formated string. But, whatever, this function could
-help. May be.
+is to **avoid** any comparison of XML formated strings. But, whatever, this
+function could help. Maybe.
 
 .. py:method:: XmlTestMixin.assertXmlEquivalentOutputs(data, expected)
 

requirements.txt

@@ -1,3 +1,5 @@
 pytest>=2.0.3
 pytest-cov>=1.8.1
 lxml>=2.3,<3.4.0
+tox>=1.8.1
+sphinx>=1.2.3

setup.py

@@ -8,7 +8,6 @@
 - Source: https://github.com/Exirel/python-xmlunittest
 
 """
-
 import codecs
 import os
 
@@ -25,7 +24,6 @@ def read(*parts):
     'Intended Audience :: Developers',
     'License :: OSI Approved :: MIT License',
     'Programming Language :: Python :: 2.7',
-    'Programming Language :: Python :: 3.3',
     'Programming Language :: Python :: 3.4',
     'Topic :: Software Development :: Libraries :: Python Modules',
     'Topic :: Software Development :: Testing',

tox.ini

@@ -1,11 +1,11 @@
 [tox]
-envlist = py27, py33, py34
+envlist = py27, py34
 
 [testenv]
 
 commands =
-    py.test
+    py.test test.py
 
 deps =
-    lxml==2.3
+    lxml==3.0
     pytest==2.6.4

xmlunittest.py

@@ -17,15 +17,13 @@ class XmlTestMixin(object):
 
     One may want to extends unittest.TestCase itself, and then uses this
     mixin class to add specific XML assertions.
-
     """
     default_partial_tag = 'partialTest'
 
     def assertXmlDocument(self, data):
         """Asserts `data` is an XML document and returns it.
 
         Assertion and XML parsing using lxml.
-
         """
         # no assertion yet
         try:
@@ -57,7 +55,6 @@ def assertXmlNamespace(self, node, prefix, uri):
         """Asserts `node` declares namespace `uri` using `prefix`.
 
         One can use this method on element node.
-
         """
         self.assertIn(prefix, node.nsmap)
         self.assertEqual(node.nsmap.get(prefix), uri)
@@ -67,7 +64,6 @@ def assertXmlHasAttribute(self, node, attribute, **kwargs):
 
         Argument `attribute` must be the attribute's name, with
         namespace's prefix (notation 'ns:att' and not '{uri}att').
-
         """
         assert attribute in node.attrib
 
@@ -79,9 +75,7 @@ def assertXmlHasAttribute(self, node, attribute, **kwargs):
                           kwargs.get('expected_values'))
 
     def assertXmlNode(self, node, **kwargs):
-        """Asserts `node` is an element node with expected tag and value.
-
-        """
+        """Asserts `node` is an element node with expected tag and value."""
         # Assert `node` is an element node and not None or a string or
         # anything like this
         self.assertIsInstance(node, etree._Element)
@@ -189,15 +183,17 @@ def assertXmlValidXSchema(self, node, xschema=None, filename=None,
 
         if xschema is None and filename is not None:
             with open(filename, 'r') as xschema_file:
-                schema = etree.XMLSchema(etree.XML(xschema_file.read().encode(encoding)))
+                schema = etree.XMLSchema(
+                    etree.XML(xschema_file.read().encode(encoding)))
 
         if schema is None:
             raise ValueError('No valid XMLSchema given.')
 
         if not schema.validate(node):
             self.fail(schema.error_log.last_error)
 
-    def assertXmlValidRelaxNG(self, node, relaxng=None, filename=None, encoding='utf-8'):
+    def assertXmlValidRelaxNG(self, node, relaxng=None, filename=None,
+                              encoding='utf-8'):
         """Asserts XML node is valid according to the given RelaxNG."""
         schema = None
 
@@ -208,7 +204,8 @@ def assertXmlValidRelaxNG(self, node, relaxng=None, filename=None, encoding='utf
 
         if relaxng is None and filename is not None:
             with open(filename, 'r') as relaxng_file:
-                schema = etree.RelaxNG(etree.XML(relaxng_file.read().encode(encoding)))
+                schema = etree.RelaxNG(
+                    etree.XML(relaxng_file.read().encode(encoding)))
 
         if schema is None:
             raise ValueError('No valid RelaxNG given.')
@@ -225,7 +222,6 @@ def assertXmlEquivalentOutputs(self, data, expected):
         check than just a kind of output.
 
         See LXMLOutputChecker documentation for more information.
-
         """
         checker = LXMLOutputChecker()
 
@@ -239,10 +235,9 @@ def assertXmlEquivalentOutputs(self, data, expected):
 class XmlTestCase(unittest.TestCase, XmlTestMixin):
     """XML test case for unit test using python unittest built-in package.
 
-    One can extends this class for his test case and use helpful assertion
-    method.
+    One can extends this class for their test cases and use helpful assertion
+    methods.
 
     XML parsing uses python lxml.etree.
-
     """
     pass