uEdition 0.8.0__py3-none-any.whl → 1.0.0__py3-none-any.whl

uedition/settings.py

@@ -6,19 +6,20 @@
 All application settings are accessed via the `settings` dictionary.
 """
 import os
+from typing import Annotated, Any, Dict, Tuple, Type
 
 from pydantic import BaseModel
 from pydantic.fields import FieldInfo
+from pydantic.functional_validators import BeforeValidator
 from pydantic_settings import BaseSettings, PydanticBaseSettingsSource
 from yaml import safe_load
-from typing import Any, Type, Tuple, Dict
 
 
 class YAMLConfigSettingsSource(PydanticBaseSettingsSource):
     """Loads the configuration settings from a YAML file."""
 
     def get_field_value(
-        self: "YAMLConfigSettingsSource", field: FieldInfo, field_name: str
+        self: "YAMLConfigSettingsSource", field: FieldInfo, field_name: str  # noqa: ARG002
     ) -> Tuple[Any, str, bool]:
         """Get the value of a specific field."""
         encoding = self.config.get("env_file_encoding")
@@ -37,11 +38,11 @@ class YAMLConfigSettingsSource(PydanticBaseSettingsSource):
 
     def prepare_field_value(
         self: "YAMLConfigSettingsSource",
-        field_name: str,
-        field: FieldInfo,
-        value: Any,
-        value_is_complex: bool,
-    ) -> Any:
+        field_name: str,  # noqa: ARG002
+        field: FieldInfo,  # noqa: ARG002
+        value: Any,  # noqa: ANN401
+        value_is_complex: bool,  # noqa: ARG002, FBT001
+    ) -> Any:  # noqa: ANN401
         """Just return the value."""
         return value
 
@@ -50,33 +51,14 @@ class YAMLConfigSettingsSource(PydanticBaseSettingsSource):
         d: Dict[str, Any] = {}
 
         for field_name, field in self.settings_cls.model_fields.items():
-            field_value, field_key, value_is_complex = self.get_field_value(
-                field, field_name
-            )
-            field_value = self.prepare_field_value(
-                field_name, field, field_value, value_is_complex
-            )
+            field_value, field_key, value_is_complex = self.get_field_value(field, field_name)
+            field_value = self.prepare_field_value(field_name, field, field_value, value_is_complex)
             if field_value is not None:
                 d[field_key] = field_value
 
         return d
 
 
-def uedition_yaml_settings(settings: BaseSettings) -> dict[str, Any]:
-    """Load the settings from a uEdition.yaml or uEdition.yml file."""
-    if os.path.exists("uEdition.yaml"):
-        with open(
-            "uEdition.yaml", encoding=settings.__config__.env_file_encoding
-        ) as in_f:
-            return safe_load(in_f)
-    elif os.path.exists("uEdition.yml"):
-        with open(
-            "uEdition.yml", encoding=settings.__config__.env_file_encoding
-        ) as in_f:
-            return safe_load(in_f)
-    return dict()
-
-
 class LanguageSetting(BaseModel):
     """Settings for a single language."""
 
@@ -106,6 +88,22 @@ class AuthorSettings(BaseModel):
     """The author's contact e-mail."""
 
 
+class OuputSettings(BaseModel):
+    """Settings for the output configuration."""
+
+    path: str = "docs"
+    """The output path."""
+    tei: bool = True
+    """Whether to generate TEI output."""
+
+
+def convert_output_str_to_dict(value: str | dict) -> dict:
+    """Convert the simple output directory string to a dictionary."""
+    if isinstance(value, str):
+        return {"path": value}
+    return value
+
+
 class Settings(BaseSettings):
     """Application settings."""
 
@@ -115,7 +113,7 @@ class Settings(BaseSettings):
     """The author settings."""
     languages: list[LanguageSetting] = []
     """The configured languages."""
-    output: str = "docs"
+    output: Annotated[OuputSettings, BeforeValidator(convert_output_str_to_dict)] = OuputSettings()
     """The output directory."""
     repository: RepositorySettings = RepositorySettings()
     """The repository settings."""
@@ -137,6 +135,7 @@ class Settings(BaseSettings):
         return (
             init_settings,
             env_settings,
+            dotenv_settings,
             file_secret_settings,
             YAMLConfigSettingsSource(settings_cls),
         )
@@ -147,6 +146,5 @@ settings = Settings().model_dump()
 
 def reload_settings() -> None:
     """Reload the settings."""
-    global settings
     settings.clear()
     settings.update(Settings().dict())

{uedition-0.8.0.dist-info → uedition-1.0.0.dist-info}/METADATA

@@ -1,9 +1,9 @@
 Metadata-Version: 2.1
 Name: uEdition
-Version: 0.8.0
-Project-URL: Documentation, https://github.com/unknown/uedition#readme
-Project-URL: Issues, https://github.com/unknown/uedition/issues
-Project-URL: Source, https://github.com/unknown/uedition
+Version: 1.0.0
+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
 Author-email: Mark Hall <mark.hall@work.room3b.eu>
 License-Expression: MIT
 License-File: LICENSE.txt
@@ -15,7 +15,7 @@ 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: jupyter-book<1.0.0,>=0.15.1
+Requires-Dist: jupyter-book<2.0.0,>=1.0.0
 Requires-Dist: livereload
 Requires-Dist: lxml<6.0.0,>=4.9.2
 Requires-Dist: pydantic-settings<3.0.0,>=2.0.0
@@ -48,6 +48,16 @@ The recommended installation for use is via `pipx`:
 pipx install uedition
 ```
 
+All commands can then be run via
+
+```console
+uEdition {command}
+```
+
+## Documentation
+
+Full documentation is available at [https://uedition.readthedocs.io](https://uedition.readthedocs.io).
+
 ## License
 
-`uedition` is distributed under the terms of the [MIT](https://spdx.org/licenses/MIT.html) license.
+The μEdition is distributed under the terms of the [MIT](https://spdx.org/licenses/MIT.html) license.

uedition-1.0.0.dist-info/RECORD

@@ -0,0 +1,26 @@
+uedition/CHANGELOG.md,sha256=NTTpW1nGpmwqXkLHEoLTHrmyGBXZINKch2Kj_cYZnZY,1356
+uedition/__about__.py,sha256=rLZ6J6d8BZjSI-Yq5EyJrB0Diw4iKah6vRHCOmIswZw,157
+uedition/__init__.py,sha256=xDDK2i5l1NLhxq6_LJH5g7UJDrFEjIJNmT2tcg7xNWI,301
+uedition/__main__.py,sha256=Pg_yGV-ndR2iiImDC3f017llSX6pSYMslIwZlw8vEpQ,189
+uedition/settings.py,sha256=4jWfjD1KmYTwzeD6DhP9taWS-zFp9XHxo1QqUqsSlrA,4774
+uedition/cli/__init__.py,sha256=h3N4ZwgRC72IlkCsTbke4PLTFv-_pn1-npXXPC7S78U,1642
+uedition/cli/build.py,sha256=oeRvkHdLGm5Wb7-UuvjHTMQiuReb9GKYvkDv-W-uV0g,7741
+uedition/cli/check.py,sha256=Jlkyw6mgcz3HM-wJpmzCtKv054MFolCe7m6bSUDtsZA,7005
+uedition/cli/create.py,sha256=Q-SvDq9VtmUP4DQhuuvt1eZ_72sX8_tcFOj2Bt_T6J8,371
+uedition/cli/language.py,sha256=IqSJrZbrQzU-7TJqnCBeC2HUs1N01EAa7jFMvfXTsoA,1943
+uedition/cli/serve.py,sha256=UfVsY26OW9yAz7rnjjatz1gEDGIi1kaTYlkUAiVCuRw,1391
+uedition/cli/update.py,sha256=XKHnvorHqizsB5zP-8ifMrgnQuq6zRk6Tb03dBz_MI4,377
+uedition/ext/__init__.py,sha256=hAK3MB5il4tAkfWnZNVxIJhfJ5vN0Fdmmtz0ZAYsvo4,406
+uedition/ext/config.py,sha256=wmy3sW0g4yha00LRvuHlYc1OnVEpit75U6uD8mPPu_U,5738
+uedition/ext/language_switcher.css,sha256=y4LzkCgCm6E_nHt15I4Ku5QzBNpjwda9bt9FsqD1ybM,132
+uedition/ext/language_switcher.js,sha256=HIgQiLg0WGS_G_VjpfEpTDLqb1HwHxcL3r6mdoSUix4,2697
+uedition/ext/language_switcher.py,sha256=tHpf4HsvMtatVn5dQ3EFlrk5urFaMzsZZY755cvgCu8,1425
+uedition/ext/tei/__init__.py,sha256=8KgVi31bz8nI65m6u4EdT_f1qNCP45HrU0V7MSGlZxA,1074
+uedition/ext/tei/builder.py,sha256=XLFM11Gnt_4G4H-2gaJyjOgko_aMmvgZnKftMsSk8qw,11743
+uedition/ext/tei/parser.py,sha256=PVc-rhNTmFRSsz7HhlYVQrQCdZ-aEGX4z16-g_vFTE4,11286
+uedition/ext/tei/tei_download.js,sha256=5_IPCuamZGPXWriPPPz5wA-zo0Y0Oy1858S6ltxSdQ8,2151
+uedition-1.0.0.dist-info/METADATA,sha256=Xo9beHSFPrUMMC-DiGQNOLIL_Uq5salbOiMi7hXB8z8,2210
+uedition-1.0.0.dist-info/WHEEL,sha256=TJPnKdtrSue7xZ_AVGkp9YXcvDrobsjBds1du3Nx6dc,87
+uedition-1.0.0.dist-info/entry_points.txt,sha256=cDOOVBb1SZ072ZkY1hW4Y7I_WKKGCtCJtDY1XST1Hr4,96
+uedition-1.0.0.dist-info/licenses/LICENSE.txt,sha256=MhLJl8GE8mnuO5i_pvKaobpIGnhiAEdkY-a6LKiuwCE,1101
+uedition-1.0.0.dist-info/RECORD,,

{uedition-0.8.0.dist-info → uedition-1.0.0.dist-info}/WHEEL

@@ -1,4 +1,4 @@
 Wheel-Version: 1.0
-Generator: hatchling 1.21.0
+Generator: hatchling 1.21.1
 Root-Is-Purelib: true
 Tag: py3-none-any

uedition-1.0.0.dist-info/entry_points.txt

@@ -0,0 +1,5 @@
+[console_scripts]
+uEdition = uedition.cli:app
+
+[sphinx.builders]
+tei = uedition.ext.tei.builder

uedition-0.8.0.dist-info/RECORD

@@ -1,22 +0,0 @@
-uedition/__about__.py,sha256=ZKY67hSUtUpZScVZxX9OP2T8_jgQEouuMOKpfXwtpjY,157
-uedition/__init__.py,sha256=IfQLccTve4Bc-f7TpeuOwXWE03DFAJoWpveFacMiBSA,285
-uedition/__main__.py,sha256=FpsS6LdCNPdC5twonoqvfrqWDyCNreKQz7t9ZeSHcLI,182
-uedition/settings.py,sha256=n1L-c-gkvlowGSMuuH5UT_B2WBUMckQgy5Uu2md56fY,4708
-uedition/cli/__init__.py,sha256=5-kozUHJCDa0-ii9fPq6GtZQCC2sQG1L5WiRHuPiKNg,1528
-uedition/cli/build.py,sha256=Z9yQ2-FxcEGtoOPvWBiJpaCPJArKuScJEXdVr1Nw3pE,6204
-uedition/cli/check.py,sha256=OE5Mis1PwCwqnVBk1waR4AyOVeGBzI5Rudp653hMKAw,7352
-uedition/cli/create.py,sha256=Q-SvDq9VtmUP4DQhuuvt1eZ_72sX8_tcFOj2Bt_T6J8,371
-uedition/cli/language.py,sha256=2UYF_rHZOsDEpBODzqOhztV1Kjq_lwef06NGO33Fo4o,2001
-uedition/cli/serve.py,sha256=_Bcgk0JLhfHxipZHE6jm9kN5_5Ksf-HjK4uThUmc3ac,1341
-uedition/cli/update.py,sha256=xzMnXXJmC1ZuyWjZQC-Cd9LCnbu6ZxybjwDX-4VomoM,357
-uedition/ext/__init__.py,sha256=p7I0TUjlm2Gsg8x3M9Ymc7Xa62DP8ExdzWwCaIgdhQg,395
-uedition/ext/config.py,sha256=Fo4uxc9lskB0tanpO0durw1-jX6ZIL6jmi0dP_HSqH0,6192
-uedition/ext/language_switcher.css,sha256=y4LzkCgCm6E_nHt15I4Ku5QzBNpjwda9bt9FsqD1ybM,132
-uedition/ext/language_switcher.js,sha256=5CL1Es5T_s0qXcbYtpycvh0tMNdn97MHWCoGECe5w0w,2661
-uedition/ext/language_switcher.py,sha256=2kWXKyVyPCUFIdO24azyNg03GYrJwasJ84wNpM1eFFY,1369
-uedition/ext/tei.py,sha256=VOVbecTA7b4HiJuh-ZAc9ZJd0DsJUmwUO-JO_wvByDk,11380
-uedition-0.8.0.dist-info/METADATA,sha256=RE11bhXsEdpEWmrGo6c1g5mOk8iN4nowGQJJIT7ynfg,2014
-uedition-0.8.0.dist-info/WHEEL,sha256=mRYSEL3Ih6g5a_CVMIcwiF__0Ae4_gLYh01YFNwiq1k,87
-uedition-0.8.0.dist-info/entry_points.txt,sha256=Mor9i2VYxcNQcLbMmWGpFYSwsMs3MyewnLmFI3IG0Ls,46
-uedition-0.8.0.dist-info/licenses/LICENSE.txt,sha256=MhLJl8GE8mnuO5i_pvKaobpIGnhiAEdkY-a6LKiuwCE,1101
-uedition-0.8.0.dist-info/RECORD,,

uedition-0.8.0.dist-info/entry_points.txt

@@ -1,2 +0,0 @@
-[console_scripts]
-uEdition = uedition.cli:app