PyPI - tutor - Versions diffs - 23.0.0.dev3191__tar.gz → 23.0.0.dev3194__tar.gz - Mend

@@ -0,0 +1,79 @@
+# https://hatch.pypa.io/latest/how-to/config/dynamic-metadata/
+import os
+import re
+import typing as t
+from hatchling.metadata.plugin.interface import MetadataHookInterface
+HERE = os.path.dirname(__file__)
+# Official plugins listed in requirements/plugins.txt are all hosted under this
+# GitHub organization, in a repository that has the same name as the package.
+PLUGINS_GITHUB_ORG = "https://github.com/overhangio"
+# Plugin requirements must be of the form "<name><version specifier>", such as
+# "tutor-mfe>=22.0.0,<23.0.0". Extras, environment markers and URLs are rejected
+# rather than silently dropped when the requirement is rewritten for Tutor Main.
+PLUGIN_REQUIREMENT_REGEX = re.compile(
+    r"^(?P<name>[A-Za-z0-9](?:[A-Za-z0-9._-]*[A-Za-z0-9])?)\s*(?P<specifier>([<>=!~]=?[^;\[\]@]*)?)$"
+)
+class MetaDataHook(MetadataHookInterface):
+    def update(self, metadata: dict[str, t.Any]) -> None:
+        metadata["dependencies"] = load_requirements("base.in")
+        metadata["optional-dependencies"] = {
+            "dev": load_requirements("dev.txt"),
+            "full": load_plugin_requirements(),
+        }
+def load_requirements(filename: str) -> list[str]:
+    requirements = []
+    with open(
+        os.path.join(HERE, "requirements", filename), "rt", encoding="utf-8"
+    ) as f:
+        for line in f:
+            line = line.strip()
+            if line != "" and not line.startswith("#"):
+                requirements.append(line)
+    return requirements
+def load_plugin_requirements() -> list[str]:
+    """
+    Load the official plugin requirements from requirements/plugins.txt.
+    That file always pins plugins to PyPI version ranges, on every branch. In
+    Tutor Main (i.e: when the version suffix is "main"), plugins are installed
+    from the main branch of their GitHub repository instead. This is the same
+    mechanism that sets OPENEDX_COMMON_VERSION to "master" in Tutor Main, and it
+    means that plugins.txt does not differ between the main and release
+    branches, so it never conflicts when one is merged into the other.
+    """
+    requirements = load_requirements("plugins.txt")
+    if load_version_suffix() != "main":
+        return requirements
+    main_requirements = []
+    for requirement in requirements:
+        match = PLUGIN_REQUIREMENT_REGEX.match(requirement)
+        if not match:
+            raise ValueError(
+                f"Unsupported plugin requirement: '{requirement}'. Expected "
+                "'<name><version specifier>' with no extras, markers or URL."
+            )
+        name = match.group("name")
+        main_requirements.append(f"{name}@git+{PLUGINS_GITHUB_ORG}/{name}@main")
+    return main_requirements
+def load_version_suffix() -> str:
+    """
+    Read __version_suffix__ from tutor/__about__.py without importing tutor,
+    which is not installed yet at build time.
+    """
+    with open(os.path.join(HERE, "tutor", "__about__.py"), encoding="utf-8") as f:
+        match = re.search(r'^__version_suffix__ = "([^"]*)"', f.read(), re.MULTILINE)
+    if not match:
+        raise ValueError("Could not find __version_suffix__ in tutor/__about__.py")
+    return match.group(1)

@@ -1,6 +1,6 @@
 Metadata-Version: 2.5
 Name: tutor
-Version: 23.0.0.dev3191
+Version: 23.0.0.dev3194
 Summary: The Docker-based Open edX distribution designed for peace of mind
 Project-URL: Homepage, https://docs.tutor.edly.io/
 Project-URL: Documentation, https://docs.tutor.edly.io/

@@ -9,6 +9,11 @@ from tutor.types import Config, ConfigValue, cast_config, get_typed
 CONFIG_FILENAME = "config.yml"
+# Default value of the MEILISEARCH_URL setting. It is duplicated here from
+# config/defaults.yml because loading the configuration defaults is slow. The
+# two values are checked to be in sync by the unit tests.
+MEILISEARCH_URL_DEFAULT = "http://meilisearch:7700"
 def load(root: str) -> Config:
     """
@@ -342,3 +347,23 @@ def _update_enabled_plugins_on_unload(_plugin: str, _root: str, config: Config)
     Note that this action must be performed after the plugin has been unloaded, hence the low priority.
     """
     save_enabled_plugins(config)
+@hooks.Actions.CONFIG_LOADED.add()
+def _check_meilisearch_url(config: Config) -> None:
+    """
+    Warn the user in case Meilisearch is not run by Tutor while MEILISEARCH_URL
+    still points at the Tutor-managed instance.
+    Meilisearch is a required component of the Open edX platform: RUN_MEILISEARCH=false
+    does not disable it, it only indicates that it is hosted externally.
+    """
+    if get_typed(config, "RUN_MEILISEARCH", bool, True):
+        return
+    if get_typed(config, "MEILISEARCH_URL", str, "") == MEILISEARCH_URL_DEFAULT:
+        fmt.echo_alert(
+            f'Warning: RUN_MEILISEARCH=false, but MEILISEARCH_URL is still set to its default value "{MEILISEARCH_URL_DEFAULT}". '
+            "Meilisearch is a required component of the Open edX platform, so RUN_MEILISEARCH=false only means that it is hosted "
+            "externally. Set MEILISEARCH_URL to the URL of an existing, preconfigured Meilisearch instance, or set "
+            "RUN_MEILISEARCH=true to have Tutor run its own."
+        )

tutor 23.0.0.dev3191__tar.gz → 23.0.0.dev3194__tar.gz

tutor 23.0.0.dev3191tar.gz → 23.0.0.dev3194tar.gz