uEdition 2.0.0a1__tar.gz → 2.0.0b1__tar.gz

{uedition-2.0.0a1 → uedition-2.0.0b1}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: uEdition
-Version: 2.0.0a1
+Version: 2.0.0b1
 Project-URL: Documentation, https://github.com/uEdition/uEdition#readme
 Project-URL: Issues, https://github.com/uEdition/uEdition/issues
 Project-URL: Source, https://github.com/uEdition/uEdition
@@ -16,16 +16,19 @@ Classifier: Programming Language :: Python :: 3.13
 Classifier: Programming Language :: Python :: Implementation :: CPython
 Classifier: Programming Language :: Python :: Implementation :: PyPy
 Requires-Python: >=3.10
-Requires-Dist: copier<10.0.0,>=9.0.0
+Requires-Dist: httpx<0.29,>=0.28.1
 Requires-Dist: livereload
 Requires-Dist: lxml<6.0.0,>=4.9.2
 Requires-Dist: myst-parser<5,>=4.0.1
+Requires-Dist: packaging==24.2
 Requires-Dist: pydantic-settings<3.0.0,>=2.0.0
 Requires-Dist: pydantic<3.0.0,>=2.0.0
 Requires-Dist: pyyaml<7.0.0,>=6.0.0
 Requires-Dist: sphinx-book-theme<2,>=1.1.4
 Requires-Dist: sphinx-external-toc<2,>=1.0.1
 Requires-Dist: sphinx<9,>=8.2.3
+Requires-Dist: strictyaml<2,>=1.7.3
+Requires-Dist: tomlkit<0.14,>=0.13.2
 Requires-Dist: typer<1.0.0
 Description-Content-Type: text/markdown
 

uedition-2.0.0b1/docs/en/index.md

@@ -0,0 +1,56 @@
+# μEdition
+
+The process of creating and making available a (critical) digital edition often presents projects with a range of significant
+hurdles, particularly around technical knowledge and hosting costs. The μEdition is a framwork that lowers these barriers by
+providing a simple tool that supports users in easily building (multi-lingual) digital editions that can then easily be made
+available online using free or low-cost hosting solutions.
+
+:::{admonition} Getting Help
+:class: tip
+
+The μEdition is still a young project and relies on your feedback to further lower the barriers to its use. Whether this is
+adding documentation on how to do things, fixing broken things, or adding extra features, please let us know what is needed
+and then we can make it better.
+
+If you have any questions about anything related to the μEdition, please use our GitHub Discussions forum to ask:
+[https://github.com/uEdition/uEdition/discussions](https://github.com/uEdition/uEdition/discussions).
+
+If you run into any bugs, then please report these via the GitHub Issues and we can get them fixed:
+[https://github.com/uEdition/uEdition/issues](https://github.com/uEdition/uEdition/issues).
+:::
+
+## Contents
+
+:::{tableofcontents}
+:::
+
+## Quickstart
+
+To quickly get started with the μEdition follow these steps:
+
+1. Install [Hatch](https://hatch.pypa.io/latest/install/) for your operating system.
+2. Create a new folder for your μEdition.
+3. Download the default {download}`_static/pyproject.toml` and move that into your new folder.
+4. Open a new terminal, change into your new folder and run the following command:
+
+   :::{code-block} console
+   hatch run init
+   :::
+
+   This creates the configuration file ({file}`uEdition.yml`) and table of contents ({file}`toc.yml`).
+
+5. Then run the following command to add content in a new language:
+
+   :::{code-block} console
+   hatch run language add
+   :::
+
+   This will ask you a few questions about the new language and then create the required files.
+
+5. Then run the following command to start the writing server:
+
+   :::{code-block} console
+   hatch run serve
+   :::
+
+Your new μEdition will be available at http://localhost:8000.

{uedition-2.0.0a1 → uedition-2.0.0b1}/docs/pyproject.toml

@@ -18,12 +18,14 @@ Issues = "https://github.com/uEdition/uEdition/-/issues"
 Source = "https://github.com/uEdition/uEdition/-"
 
 [tool.hatch.envs.default]
-dependencies = ["uedition>=1.3.0,<2",]
+dependencies = ["uEdition<2.1,>=2.0.0a2", "uEdition_editor<2.1,>=2.0.0a2"]
 skip-install = true
 
 [tool.hatch.envs.default.scripts]
 build = "uEdition build {args}"
+init = "uEdition init {args}"
 serve = "uEdition serve {args}"
 update = "uEdition update {args}"
-add-language = "uEdition language add {args}"
-update-language = "uEdition language update {args}"
+migrate = "uEdition migrate {args}"
+language = "uEdition language {args}"
+edit = "uvicorn --port 8000 uedition_editor:app {args} {args}"

uedition-2.0.0b1/docs/static/pyproject.toml

@@ -0,0 +1,29 @@
+[build-system]
+requires = ["hatchling"]
+build-backend = "hatchling.build"
+
+[project]
+name = "edition_name"
+description = "edition_title"
+requires-python = ">=3.10"
+keywords = []
+authors = [{ name = "author_name", email = "author_email@example.com" }]
+classifiers = []
+dependencies = []
+version = "1.0.0"
+
+[project.urls]
+Documentation = "http://edition.com"
+Issues = "http://edition.com"
+Source = "http://edition.com"
+
+[tool.hatch.envs.default]
+dependencies = ["uEdition<2.1,>=2.0.0a2", "uEditor<2.1,>=2.0.0a2"]
+skip-install = true
+
+[tool.hatch.envs.default.scripts]
+build = "uEdition build {args}"
+serve = "uEdition serve {args}"
+update = "uEdition update {args}"
+migrate = "uEdition migrate {args}"
+language = "uEdition language {args}"

{uedition-2.0.0a1 → uedition-2.0.0b1}/pyproject.toml

@@ -3,6 +3,22 @@ requires = ["hatchling"]
 build-backend = "hatchling.build"
 
 [project]
+dependencies = [
+  "httpx>=0.28.1,<0.29",
+  "lxml>=4.9.2,<6.0.0",
+  "livereload",
+  "myst-parser>=4.0.1,<5",
+  "packaging==24.2",
+  "pydantic>=2.0.0,<3.0.0",
+  "pydantic-settings>=2.0.0,<3.0.0",
+  "PyYAML>=6.0.0,<7.0.0",
+  "sphinx>=8.2.3,<9",
+  "sphinx_external_toc>=1.0.1,<2",
+  "sphinx-book-theme>=1.1.4,<2",
+  "strictyaml>=1.7.3,<2",
+  "tomlkit>=0.13.2,<0.14",
+  "typer<1.0.0",
+]
 name = "uEdition"
 description = ''
 readme = "README.md"
@@ -20,19 +36,6 @@ classifiers = [
   "Programming Language :: Python :: Implementation :: CPython",
   "Programming Language :: Python :: Implementation :: PyPy",
 ]
-dependencies = [
-  "copier>=9.0.0,<10.0.0",
-  "lxml>=4.9.2,<6.0.0",
-  "livereload",
-  "myst-parser>=4.0.1,<5",
-  "pydantic>=2.0.0,<3.0.0",
-  "pydantic-settings>=2.0.0,<3.0.0",
-  "PyYAML>=6.0.0,<7.0.0",
-  "sphinx>=8.2.3,<9",
-  "sphinx_external_toc>=1.0.1,<2",
-  "sphinx-book-theme>=1.1.4,<2",
-  "typer<1.0.0",
-]
 dynamic = ["version"]
 
 [project.scripts]

{uedition-2.0.0a1 → uedition-2.0.0b1}/uedition/__about__.py

@@ -3,4 +3,4 @@
 # SPDX-License-Identifier: MIT
 """About this package."""
 
-__version__ = "2.0.0a1"
+__version__ = "2.0.0b1"

uedition-2.0.0b1/uedition/cli/__init__.py

@@ -0,0 +1,18 @@
+# SPDX-FileCopyrightText: 2023-present Mark Hall <mark.hall@work.room3b.eu>
+#
+# SPDX-License-Identifier: MIT
+"""uEdtion Command-line Tool."""
+
+from rich import print as output
+
+from uedition.__about__ import __version__
+from uedition.cli import build, init, language, migrate, serve, update  # noqa:F401
+from uedition.cli.base import app
+from uedition.settings import settings
+
+
+@app.command()
+def version() -> None:
+    """Output the current μEdition version."""
+    output(f"μEdition:      {__version__}")
+    output(f"Configuration: {settings['version']}")

uedition-2.0.0b1/uedition/cli/base.py

@@ -0,0 +1,8 @@
+# SPDX-FileCopyrightText: 2023-present Mark Hall <mark.hall@work.room3b.eu>
+#
+# SPDX-License-Identifier: MIT
+"""The μEdition CLI base."""
+
+import typer
+
+app = typer.Typer()

{uedition-2.0.0a1 → uedition-2.0.0b1}/uedition/cli/build.py

@@ -10,6 +10,7 @@ from shutil import copytree, ignore_patterns, rmtree
 
 from yaml import safe_dump, safe_load
 
+from uedition.cli.base import app
 from uedition.settings import NoConfigError, reload_settings, settings
 
 LANDING_PAGE_TEMPLATE = """\
@@ -187,18 +188,19 @@ def full_build(lang: dict) -> None:
             check=False,
             shell=False,
         )
-    copytree(
-        path.join("_build", lang["path"], "html"),
-        path.join(settings["output"]["path"], lang["path"]),
-        dirs_exist_ok=True,
-    )
-    if settings["output"]["tei"]:
+    if path.isdir(path.join("_build", lang["path"], "html")):
         copytree(
-            path.join("_build", lang["path"], "tei"),
+            path.join("_build", lang["path"], "html"),
             path.join(settings["output"]["path"], lang["path"]),
-            ignore=ignore_patterns("_sphinx_design_static"),
             dirs_exist_ok=True,
         )
+        if settings["output"]["tei"] and path.isdir(path.join("_build", lang["path"], "tei")):
+            copytree(
+                path.join("_build", lang["path"], "tei"),
+                path.join(settings["output"]["path"], lang["path"]),
+                ignore=ignore_patterns("_sphinx_design_static"),
+                dirs_exist_ok=True,
+            )
 
 
 def partial_build(lang: dict) -> None:
@@ -227,22 +229,24 @@ def partial_build(lang: dict) -> None:
             check=False,
             shell=False,
         )
-    copytree(
-        path.join("_build", lang["path"], "html"),
-        path.join(settings["output"]["path"], lang["path"]),
-        dirs_exist_ok=True,
-    )
-    if settings["output"]["tei"]:
+    if path.isdir(path.join("_build", lang["path"], "html")):
         copytree(
-            path.join("_build", lang["path"], "tei"),
+            path.join("_build", lang["path"], "html"),
             path.join(settings["output"]["path"], lang["path"]),
-            ignore=ignore_patterns("_sphinx_design_static"),
             dirs_exist_ok=True,
         )
+        if settings["output"]["tei"] and path.isdir(path.join("_build", lang["path"], "tei")):
+            copytree(
+                path.join("_build", lang["path"], "tei"),
+                path.join(settings["output"]["path"], lang["path"]),
+                ignore=ignore_patterns("_sphinx_design_static"),
+                dirs_exist_ok=True,
+            )
 
 
-def run() -> None:
-    """Build the full uEdition."""
+@app.command()
+def build() -> None:
+    """Build the full μEdition."""
     if not path.exists("uEdition.yml") and not path.exists("uEdition.yaml"):
         raise NoConfigError()
     if path.exists(settings["output"]["path"]):

uedition-2.0.0b1/uedition/cli/init.py

@@ -0,0 +1,22 @@
+# SPDX-FileCopyrightText: 2023-present Mark Hall <mark.hall@work.room3b.eu>
+#
+# SPDX-License-Identifier: MIT
+"""Local server that automatically rebuilds on changes."""
+
+from os import path
+
+from yaml import safe_dump
+
+from uedition.cli.base import app
+from uedition.settings import NoConfigError
+
+
+@app.command()
+def init(force: bool = False) -> None:  # noqa: ARG001 FBT001 FBT002
+    """Initialise a new μEdition."""
+    if path.exists("uEdition.yml") and path.exists("uEdition.yaml"):
+        raise NoConfigError()
+    with open("uEdition.yml", "w") as out_f:
+        safe_dump({"version": "2", "output": "site"}, out_f)
+    with open("toc.yml", "w") as out_f:
+        safe_dump({"format": "jb-book", "root": "index"}, out_f)

uedition-2.0.0b1/uedition/cli/language.py

@@ -0,0 +1,63 @@
+# SPDX-FileCopyrightText: 2023-present Mark Hall <mark.hall@work.room3b.eu>
+#
+# SPDX-License-Identifier: MIT
+"""The μEdition language functionality."""
+
+import os
+from typing import Annotated
+
+from rich import print as output
+from typer import Option, Typer
+from yaml import safe_dump, safe_load
+
+from uedition.cli.base import app
+from uedition.settings import NoConfigError
+
+lang_app = Typer(help="Language configuration functionality")
+app.add_typer(lang_app, name="language")
+
+
+@lang_app.command()
+def add(
+    code: Annotated[str, Option(prompt="Language code")],
+    label: Annotated[
+        str,
+        Option(prompt="Language name"),
+    ],
+    title: Annotated[str, Option(prompt="Title")],
+    path: str | None = None,
+) -> None:
+    """Add a language."""
+    if path is None:
+        path = code
+    if os.path.exists("uEdition.yml"):
+        with open("uEdition.yml") as in_f:
+            config = safe_load(in_f)
+    elif os.path.exists("uEdition.yaml"):
+        with open("uEdition.yaml") as in_f:
+            config = safe_load(in_f)
+    else:
+        raise NoConfigError()
+    if "languages" not in config:
+        config["languages"] = []
+    for lang in config["languages"]:
+        if lang["code"] == code:
+            output(
+                "[red bold]The language code [/red bold]"
+                f"[cyan bold]{code}[/cyan bold]"
+                "[red bold] is already configured[/red bold]"
+            )
+            return
+    if os.path.exists(path):
+        output(
+            f"[red bold]The target path [/red bold][cyan bold]{code}[/cyan bold][red bold] already exists.[/red bold]"
+        )
+    os.mkdir(path)
+    config["languages"].append({"code": code, "label": label, "path": path})
+    if "title" not in config:
+        config["title"] = {}
+    config["title"][code] = title
+    with open("uEdition.yml", "w") as out_f:
+        safe_dump(config, out_f)
+    with open(os.path.join(path, "index.md"), "w") as out_f:
+        out_f.write(f"# {title}\n")

uedition-2.0.0b1/uedition/cli/migrate.py

@@ -0,0 +1,137 @@
+# SPDX-FileCopyrightText: 2023-present Mark Hall <mark.hall@work.room3b.eu>
+#
+# SPDX-License-Identifier: MIT
+"""The μEdition migration functionality."""
+
+import os
+from os import path
+
+import tomlkit
+from rich import print as output
+
+from uedition.cli.base import app
+from uedition.settings import NoConfigError
+
+
+def cleanup_old_files() -> None:
+    """Cleanup any old files."""
+    # Scan for old files to remove
+    old_copier_files = []
+    old_config_files = []
+    for basepath, _, filenames in os.walk("."):
+        for filename in filenames:
+            if filename == ".uEdition.answers":
+                old_copier_files.append(path.join(basepath, filename))
+            elif filename in ("_config.yaml", "_config.yml"):
+                old_config_files.append(path.join(basepath, filename))
+    # Remove old copier files (v2.0.0)
+    if len(old_copier_files) > 0:
+        output(":broom: Removing old configuration answers")
+        for filename in old_copier_files:
+            os.unlink(filename)
+    # Remove old config files (v2.0.0)
+    if len(old_config_files) > 0:
+        output(":broom: Removing old configuration files")
+        for filename in old_config_files:
+            os.unlink(filename)
+
+
+def cleanup_gitignore() -> None:
+    """Cleanup the gitignore."""
+    # Update .gitignore (v2.0.0)
+    if path.isfile(".gitignore"):
+        with open(".gitignore") as in_f:
+            lines = in_f.readlines()
+        original_length = len(lines)
+        lines = [line for line in lines if line.strip() not in ("_config.yml", "_config.yaml")]
+        found = False
+        for line in lines:
+            if line.strip() == "conf.py":
+                found = True
+        if not found or len(lines) != original_length:
+            output(":broom: Updating the .gitignore")
+            if not found:
+                lines.append("conf.py\n")
+            with open(".gitignore", "w") as out_f:
+                for line in lines:
+                    out_f.write(line)
+
+
+def cleanup_pyproject() -> None:
+    """Cleanup the pyproject file."""
+    if not path.exists("pyproject.toml"):
+        raise NoConfigError()
+    with open("pyproject.toml") as in_f:
+        pyproject = tomlkit.parse(in_f.read())
+    updated = False
+    if "tool" not in pyproject:
+        pyproject["tool"] = tomlkit.table()
+    if "hatch" not in pyproject["tool"]:
+        pyproject["tool"]["hatch"] = tomlkit.table()
+    if "envs" not in pyproject["tool"]["hatch"]:
+        pyproject["tool"]["hatch"]["envs"] = tomlkit.table()
+    if "default" not in pyproject["tool"]["hatch"]["envs"]:
+        pyproject["tool"]["hatch"]["envs"]["default"] = tomlkit.table()
+    if "scripts" not in pyproject["tool"]["hatch"]["envs"]["default"]:
+        pyproject["tool"]["hatch"]["envs"]["default"]["scripts"] = tomlkit.table()
+        updated = True
+    if "add-language" in pyproject["tool"]["hatch"]["envs"]["default"]["scripts"]:
+        del pyproject["tool"]["hatch"]["envs"]["default"]["scripts"]["add-language"]
+        updated = True
+    if "update-language" in pyproject["tool"]["hatch"]["envs"]["default"]["scripts"]:
+        del pyproject["tool"]["hatch"]["envs"]["default"]["scripts"]["update-language"]
+        updated = True
+    if "migrate" not in pyproject["tool"]["hatch"]["envs"]["default"]["scripts"]:
+        pyproject["tool"]["hatch"]["envs"]["default"]["scripts"]["migrate"] = "uEdition migrate {args}"
+        updated = True
+    if "language" not in pyproject["tool"]["hatch"]["envs"]["default"]["scripts"]:
+        pyproject["tool"]["hatch"]["envs"]["default"]["scripts"]["language"] = "uEdition language {args}"
+        updated = True
+    if "init" not in pyproject["tool"]["hatch"]["envs"]["default"]["scripts"]:
+        pyproject["tool"]["hatch"]["envs"]["default"]["scripts"]["init"] = "uEdition init {args}"
+        updated = True
+    if "edit" not in pyproject["tool"]["hatch"]["envs"]["default"]["scripts"]:
+        pyproject["tool"]["hatch"]["envs"]["default"]["scripts"]["edit"] = (
+            "uvicorn --port 8000 uedition_editor:app {args} {args}"
+        )
+        updated = True
+    if updated:
+        output(":broom: Updating the pyproject.toml")
+    with open("pyproject.toml", "w") as out_f:
+        tomlkit.dump(pyproject, out_f)
+
+
+def migrate_ueditor() -> None:
+    """Migrate the μEditor to the latest supported version."""
+    ueditor_version = "uedition_editor>=2.0.0b5,<2.1"
+    output(":hammer: Updating the μEditor")
+    with open("pyproject.toml") as in_f:
+        pyproject = tomlkit.parse(in_f.read())
+    found_ueditor = False
+    for idx, dep in enumerate(pyproject["tool"]["hatch"]["envs"]["default"]["dependencies"]):
+        dep = dep.lower()  # noqa:PLW2901
+        if (
+            dep == "uedition_editor"
+            or dep.startswith("uedition_editor=")
+            or dep.startswith("uedition_editor<")
+            or dep.startswith("uedition_editor>")
+        ):
+            pyproject["tool"]["hatch"]["envs"]["default"]["dependencies"][idx] = ueditor_version
+            found_ueditor = True
+    if not found_ueditor:
+        pyproject["tool"]["hatch"]["envs"]["default"]["dependencies"].append(ueditor_version)
+    with open("pyproject.toml", "w") as out_f:
+        tomlkit.dump(pyproject, out_f)
+
+
+@app.command()
+def migrate() -> None:
+    """Migrate the μEdition to the latest version."""
+    if not path.exists("uEdition.yml") and not path.exists("uEdition.yaml") and not path.exists("pyproject.toml"):
+        raise NoConfigError()
+    output(":hammer: Migrating the μEdition")
+    cleanup_old_files()
+    cleanup_gitignore()
+    cleanup_pyproject()
+    migrate_ueditor()
+    output(":checkered_flag: Migration complete")

{uedition-2.0.0a1 → uedition-2.0.0b1}/uedition/cli/serve.py

@@ -2,11 +2,13 @@
 #
 # SPDX-License-Identifier: MIT
 """Local server that automatically rebuilds on changes."""
+
 from os import path
 from typing import Callable
 
 from livereload import Server
 
+from uedition.cli.base import app
 from uedition.cli.build import full_build, partial_build
 from uedition.settings import NoConfigError, settings
 
@@ -27,8 +29,9 @@ def build_cmd(lang: dict, full: bool = True) -> Callable[[], None]:  # noqa: FBT
         return cmd
 
 
-def run() -> None:
-    """Run the development server."""
+@app.command()
+def serve() -> None:
+    """Run the local μEdition writing server."""
     if not path.exists("uEdition.yml") and not path.exists("uEdition.yaml"):
         raise NoConfigError()
     full_rebuilds = [build_cmd(lang, full=True) for lang in settings["languages"]]

uedition-2.0.0b1/uedition/cli/update.py

@@ -0,0 +1,84 @@
+# SPDX-FileCopyrightText: 2023-present Mark Hall <mark.hall@work.room3b.eu>
+#
+# SPDX-License-Identifier: MIT
+"""The μEdition update functionality."""
+
+from enum import Enum
+from os import path
+
+import httpx
+import tomlkit
+from packaging.specifiers import SpecifierSet
+from packaging.version import Version
+from rich import print as output
+
+from uedition.cli.base import app
+from uedition.settings import NoConfigError
+
+
+class UpdateVersionOptions(Enum):
+    """Option settings for upgrade version selection."""
+
+    RELEASES = "releases"
+    PRE_RELEASES = "pre-releases"
+
+
+@app.command()
+def update(allow_versions: UpdateVersionOptions = UpdateVersionOptions.RELEASES.value) -> None:
+    """Update the μEdition to the latest version."""
+    try:
+        if not path.exists("uEdition.yml") and not path.exists("uEdition.yaml") and not path.exists("pyproject.toml"):
+            raise NoConfigError()
+        with open("pyproject.toml") as in_f:
+            pyproject = tomlkit.parse(in_f.read())
+        output(":hourglass_flowing_sand: Determining latest version")
+        response = httpx.get(
+            "https://pypi.org/simple/uedition/", headers={"Accept": "application/vnd.pypi.simple.v1+json"}
+        )
+        if response.status_code != 200:  # noqa: PLR2004
+            output(":cross_mark: Failed to determine the latest version")
+            raise Exception("PyPi access error")  # noqa: EM101
+        versions = response.json()["versions"]
+        versions.reverse()
+        target_version = None
+        for version in versions:
+            if Version(version).is_prerelease and allow_versions == UpdateVersionOptions.PRE_RELEASES:
+                target_version = Version(version)
+                break
+            elif not Version(version).is_prerelease:
+                target_version = Version(version)
+                break
+        if target_version is None:
+            raise Exception("No version found to upgrade to")  # noqa: EM101
+        target_specifier = SpecifierSet(f">={target_version},<{target_version.major}.{target_version.minor + 1}")
+        output(f":hammer: Upgrading to {target_version}")
+        if "tool" not in pyproject:
+            pyproject["tool"] = tomlkit.table()
+        if "hatch" not in pyproject["tool"]:
+            pyproject["tool"]["hatch"] = tomlkit.table()
+        if "envs" not in pyproject["tool"]["hatch"]:
+            pyproject["tool"]["hatch"]["envs"] = tomlkit.table()
+        if "default" not in pyproject["tool"]["hatch"]["envs"]:
+            pyproject["tool"]["hatch"]["envs"]["default"] = tomlkit.table()
+        if "dependencies" not in pyproject["tool"]["hatch"]["envs"]["default"]:
+            pyproject["tool"]["hatch"]["envs"]["default"]["dependencies"] = []
+        pyproject["tool"]["hatch"]["envs"]["default"]["skip-install"] = True
+        # Upgrade the uEdition version
+        found_uedition = False
+        for idx, dep in enumerate(pyproject["tool"]["hatch"]["envs"]["default"]["dependencies"]):
+            dep = dep.lower()  # noqa:PLW2901
+            if (
+                dep == "uedition"
+                or dep.startswith("uedition=")
+                or dep.startswith("uedition<")
+                or dep.startswith("uedition>")
+            ):
+                pyproject["tool"]["hatch"]["envs"]["default"]["dependencies"][idx] = f"uedition{target_specifier}"
+                found_uedition = True
+        if not found_uedition:
+            pyproject["tool"]["hatch"]["envs"]["default"]["dependencies"].append(f"uedition{target_specifier}")
+        with open("pyproject.toml", "w") as out_f:
+            tomlkit.dump(pyproject, out_f)
+        output(":checkered_flag: Upgrade complete")
+    except Exception as e:
+        output(f":cross_mark: Update failed: {e}")

{uedition-2.0.0a1 → uedition-2.0.0b1}/uedition/ext/tei/builder.py

@@ -14,6 +14,8 @@ from sphinx.locale import __
 from sphinx.util.osutil import ensuredir, os_path
 from sphinx.writers.xml import XMLWriter
 
+from uedition.ext.tei.parser import TeiElement
+
 logger = logging.getLogger(__name__)
 
 MAPPINGS = [
@@ -37,6 +39,13 @@ MAPPINGS = [
     },
     {"cls": nodes.compound, "tagname": "div", "type": "block"},
     {"cls": nodes.admonition, "tagname": "div", "type": "block"},
+    {
+        "cls": nodes.definition_list,
+        "tagname": "list",
+        "type": "block",
+        "attrs": [{"target": "type", "value": "definition"}],
+    },
+    {"cls": nodes.definition_list_item, "tagname": "item", "type": "block"},
     {"cls": sphinx.addnodes.toctree},
     {
         "cls": nodes.footnote,
@@ -105,6 +114,16 @@ class TEITranslator(nodes.GenericNodeVisitor):
         for rule in MAPPINGS:
             if isinstance(node, rule["cls"]):
                 return rule
+        if isinstance(node, TeiElement):
+            tag = node.get("tei_tag")
+            tag = tag[tag.find("}") + 1 :]
+            attrs = []
+            for key, value in node.get("tei_attributes").items():
+                if key.startswith("data-tei-block-") or key.startswith("data-tei-mark-"):
+                    continue
+                elif key.startswith("data-tei-attribute-"):
+                    attrs.append({"target": key[19:], "value": value})
+            return {"tagname": tag, "type": "block", "attrs": attrs}
         self.warn(f"Unknown node {node.__class__.__module__}.{node.__class__.__qualname__} ({node.attlist()})")
         return {"tagname": "div", "type": "block"}