fix: tweak setup.py handling of template directory

Also some pending documentation updates and some Black changes.

Author: scanny

docs/user/hdrftr.rst

@@ -77,24 +77,13 @@ Adding "zoned" header content
 -----------------------------
 
 A header with multiple "zones" is often accomplished using carefully placed tab stops.
-The required tab-stops for a center and right-aligned "zone" are part of the latent
-``Header`` style in Word, but that style is not present in the default ``python-docx``
-template and will need to be added::
 
-    >>> from docx.enum.style import WD_STYLE_TYPE
-    >>> from docx.enum.text import WD_TAB_ALIGNMENT
-    >>> styles = document.styles
-    >>> style = styles.add_style("Header", WD_STYLE_TYPE.PARAGRAPH)
-    >>> style.base_style = styles["Normal"]
-    >>> tab_stops = style.paragraph_format.tab_stops
-    >>> tab_stops.add_tab_stop(Inches(3.25), WD_TAB_ALIGNMENT.CENTER)
-    >>> tab_stops.add_tab_stop(Inches(6.5), WD_TAB_ALIGNMENT.RIGHT)
+The required tab-stops for a center and right-aligned "zone" are part of the ``Header``
+and ``Footer`` styles in Word. If you're using a custom template rather than the
+`python-docx` default, it probably makes sense to define that style in your template.
 
-If you're using a custom template rather than the `python-docx` default, it probably
-makes sense to define that style in your template.
-
-Once the ``Header`` style is present, tabs are used to separate left, center, and
-right-aligned header content::
+Inserted tab characters (``"\t"``) are used to separate left, center, and right-aligned
+header content::
 
     >>> paragraph = header.paragraphs[0]
     >>> paragraph.text = "Left Text\tCenter Text\tRight Text"
@@ -103,6 +92,10 @@ right-aligned header content::
 .. image:: /_static/img/hdrftr-02.png
    :scale: 75%
 
+The ``Header`` style is automatically applied to a new header, so the third line just
+above (applying the ``Header`` style) is unnecessary in this case, but included here to
+illustrate the general case.
+
 
 Removing a header
 -----------------

docx/compat.py

@@ -4,9 +4,7 @@
 Provides Python 2/3 compatibility objects
 """
 
-from __future__ import (
-    absolute_import, division, print_function, unicode_literals
-)
+from __future__ import absolute_import, division, print_function, unicode_literals
 
 import sys
 
@@ -16,12 +14,11 @@
 
 if sys.version_info >= (3, 0):
 
+    from collections.abc import Sequence
     from io import BytesIO
 
     def is_string(obj):
-        """
-        Return True if *obj* is a string, False otherwise.
-        """
+        """Return True if *obj* is a string, False otherwise."""
         return isinstance(obj, str)
 
     Unicode = str
@@ -32,12 +29,11 @@ def is_string(obj):
 
 else:
 
+    from collections import Sequence  # noqa
     from StringIO import StringIO as BytesIO  # noqa
 
     def is_string(obj):
-        """
-        Return True if *obj* is a string, False otherwise.
-        """
+        """Return True if *obj* is a string, False otherwise."""
         return isinstance(obj, basestring)
 
     Unicode = unicode

docx/oxml/ns.py

@@ -8,21 +8,22 @@
 
 
 nsmap = {
-    "a": ("http://schemas.openxmlformats.org/drawingml/2006/main"),
-    "c": ("http://schemas.openxmlformats.org/drawingml/2006/chart"),
-    "cp": ("http://schemas.openxmlformats.org/package/2006/metadata/core-properties"),
-    "dc": ("http://purl.org/dc/elements/1.1/"),
-    "dcmitype": ("http://purl.org/dc/dcmitype/"),
-    "dcterms": ("http://purl.org/dc/terms/"),
-    "dgm": ("http://schemas.openxmlformats.org/drawingml/2006/diagram"),
-    "m": ("http://schemas.openxmlformats.org/officeDocument/2006/math"),
-    "pic": ("http://schemas.openxmlformats.org/drawingml/2006/picture"),
-    "r": ("http://schemas.openxmlformats.org/officeDocument/2006/relationships"),
-    "sl": ("http://schemas.openxmlformats.org/schemaLibrary/2006/main"),
-    "w": ("http://schemas.openxmlformats.org/wordprocessingml/2006/main"),
-    "wp": ("http://schemas.openxmlformats.org/drawingml/2006/wordprocessingDrawing"),
-    "xml": ("http://www.w3.org/XML/1998/namespace"),
-    "xsi": ("http://www.w3.org/2001/XMLSchema-instance"),
+    "a": "http://schemas.openxmlformats.org/drawingml/2006/main",
+    "c": "http://schemas.openxmlformats.org/drawingml/2006/chart",
+    "cp": "http://schemas.openxmlformats.org/package/2006/metadata/core-properties",
+    "dc": "http://purl.org/dc/elements/1.1/",
+    "dcmitype": "http://purl.org/dc/dcmitype/",
+    "dcterms": "http://purl.org/dc/terms/",
+    "dgm": "http://schemas.openxmlformats.org/drawingml/2006/diagram",
+    "m": "http://schemas.openxmlformats.org/officeDocument/2006/math",
+    "pic": "http://schemas.openxmlformats.org/drawingml/2006/picture",
+    "r": "http://schemas.openxmlformats.org/officeDocument/2006/relationships",
+    "sl": "http://schemas.openxmlformats.org/schemaLibrary/2006/main",
+    "w": "http://schemas.openxmlformats.org/wordprocessingml/2006/main",
+    'w14': "http://schemas.microsoft.com/office/word/2010/wordml",
+    "wp": "http://schemas.openxmlformats.org/drawingml/2006/wordprocessingDrawing",
+    "xml": "http://www.w3.org/XML/1998/namespace",
+    "xsi": "http://www.w3.org/2001/XMLSchema-instance",
 }
 
 pfxmap = dict((value, key) for key, value in nsmap.items())

docx/section.py

@@ -4,9 +4,8 @@
 
 from __future__ import absolute_import, division, print_function, unicode_literals
 
-from collections import Sequence
-
 from docx.blkcntnr import BlockItemContainer
+from docx.compat import Sequence
 from docx.enum.section import WD_HEADER_FOOTER
 from docx.shared import lazyproperty
 
@@ -81,7 +80,7 @@ def even_page_footer(self):
         The content of this footer definition is ignored unless the document setting
         :attr:`~.Settings.odd_and_even_pages_header_footer` is set True.
         """
-        return _Footer(self._sectPr, self._document_part,  WD_HEADER_FOOTER.EVEN_PAGE)
+        return _Footer(self._sectPr, self._document_part, WD_HEADER_FOOTER.EVEN_PAGE)
 
     @property
     def even_page_header(self):
@@ -394,7 +393,8 @@ def _prior_headerfooter(self):
         """|_Footer| proxy on prior sectPr element or None if this is first section."""
         preceding_sectPr = self._sectPr.preceding_sectPr
         return (
-            None if preceding_sectPr is None
+            None
+            if preceding_sectPr is None
             else _Footer(preceding_sectPr, self._document_part, self._hdrftr_index)
         )
 
@@ -437,6 +437,7 @@ def _prior_headerfooter(self):
         """|_Header| proxy on prior sectPr element or None if this is first section."""
         preceding_sectPr = self._sectPr.preceding_sectPr
         return (
-            None if preceding_sectPr is None
+            None
+            if preceding_sectPr is None
             else _Header(preceding_sectPr, self._document_part, self._hdrftr_index)
         )

setup.py

@@ -35,7 +35,7 @@ def text_of(relpath):
 URL = 'https://github.com/python-openxml/python-docx'
 LICENSE = text_of('LICENSE')
 PACKAGES = find_packages(exclude=['tests', 'tests.*'])
-PACKAGE_DATA = {'docx': ['templates/*']}
+PACKAGE_DATA = {'docx': ['templates/*.xml', 'templates/*.docx']}
 
 INSTALL_REQUIRES = ['lxml>=2.3.2']
 TEST_SUITE = 'tests'