refactor: move docxcompose to optional dependencies

Author: waketzheng

docxtpl/__init__.py

@@ -11,5 +11,8 @@
 from .inline_image import InlineImage
 from .listing import Listing
 from .richtext import RichText, R, RichTextParagraph, RP
-from .subdoc import Subdoc
 from .template import DocxTemplate
+try:
+    from .subdoc import Subdoc
+except ImportError:
+    pass

docxtpl/template.py

@@ -25,13 +25,13 @@
 from jinja2.exceptions import TemplateError
 from lxml import etree
 
-from .subdoc import Subdoc
-
 if TYPE_CHECKING:
     from docx.document import Document as _Document
     from docx.oxml.document import CT_Document
     from docx.parts.story import StoryPart
 
+    from .subdoc import Subdoc
+
     class DocumentObject(_Document):
         _element: CT_Document
 
@@ -622,6 +622,8 @@ def fix_docpr_ids(self, tree) -> None:
             elt.attrib["id"] = str(self.docx_ids_index)
 
     def new_subdoc(self, docpath=None) -> Subdoc:
+        from .subdoc import Subdoc
+
         self.init_docx()
         return Subdoc(self, docpath)
 

pyproject.toml

@@ -1,23 +1,50 @@
-[tool.poetry]
+[project]
 name = "docxtpl"
-version = "0.20.1"
+dynamic = ["version"]
 description = "Python docx template engine"
-authors = ["Eric Lapouyade"]
+authors = [{name="Eric Lapouyade", email="elapouya@proton.me"}]
 readme = "README.rst"
+license = "LGPL 2.1"
+requires-python = ">=3.7"
+classifiers=[
+    "Intended Audience :: Developers",
+    "Development Status :: 4 - Beta",
+    "Programming Language :: Python :: 3",
+    "Programming Language :: Python :: 3.7",
+    "Programming Language :: Python :: 3.8",
+    "Programming Language :: Python :: 3.9",
+    "Programming Language :: Python :: 3.10",
+    "Programming Language :: Python :: 3.11",
+    "Programming Language :: Python :: 3.12",
+    "Programming Language :: Python :: 3.13",
+]
+keywords = ["jinja2"]
+dependencies = [
+    "python-docx (>=1.1.2,<2)",
+    "jinja2",
+    "lxml",
+]
+
+[project.optional-dependencies]
+subdoc = ["docxcompose"]
+docs = ["Sphinx", "sphinxcontrib-napoleon"]
+
+[dependency-groups]
+dev = ["mypy", "lxml-stubs", "flake8"]
 
-[tool.poetry.dependencies]
-python = "^3.11"
-python-docx = "^1.1.2"
-docxcompose = "^1.4.0"
-jinja2 = "^3.1.4"
+[project.urls]
+homepage = "https://github.com/elapouya/python-docx-template"
+repository = "https://github.com/elapouya/python-docx-template.git"
+document = "https://docxtpl.readthedocs.org"
 
+[tool.pdm]
+version = {source="file", path="docxtpl/__init__.py"}
+
+[tool.poetry]
+version = '0.0.0'
 
-[tool.poetry.group.dev.dependencies]
-flake8 = "^7.1.0"
-black = "^24.4.2"
-twine = "^6.1.0"
-mypy = "^1.17.0"
-lxml-stubs = "^0.5.1"
+[tool.poetry-plugin-version]
+source = "docxtpl/__init__.py"
 
 [tool.mypy]
 pretty = true
@@ -31,5 +58,5 @@ module = ["docxcompose.*"]
 ignore_missing_imports = true
 
 [build-system]
-requires = ["poetry-core"]
-build-backend = "poetry.core.masonry.api"
+requires = ["pdm-backend"]
+build-backend = "pdm.backend"