Add first step for a python ynh-dev

Author: Salamandar

.gitignore

@@ -1,3 +1,9 @@
+# Python stuff
+__pycache__/
+.*_cache/
+uv.lock
+.python-version
+
 # Apps
 *_ynh
 
@@ -11,6 +17,7 @@ Vagrantfile
 moulinette
 yunohost
 yunohost-admin
+yunohost-portal
 ssowat
 
 # Folders

custom-catalog/catalog_manager.py

@@ -0,0 +1,81 @@
+[project]
+name = "ynh-dev"
+version = "2.0"
+description = "Yunohost dev environment manager"
+readme = "README.md"
+authors = [
+    {name = "YunoHost", email = "yunohost@yunohost.org"}
+]
+requires-python = ">=3.11"
+
+dependencies = [
+    "pyinotify",
+]
+
+
+[project.scripts]
+ynh-dev = "ynh-dev:main"
+
+[dependency-groups]
+lint = [
+    "ruff",
+    "mypy>=1.18",
+]
+
+[tool.uv]
+package = false
+
+[tool.ruff]
+line-length = 120
+
+[tool.ruff.lint]
+select = [
+    "YTT",      # flake8-2020
+    "ANN",      # flake8-annotations
+    "BLE",      # flake8-blind-except
+    "B",        # flake8-bugbear
+    "A",        # flake8-builtins
+    "C4",       # flake8-comprehensions
+    "DTZ",      # flake8-datetimez
+    "ISC",      # flake8-implicit-str-concat
+    "ICN",      # flake8-import-conventions
+    # "LOG",      # flake8-logging
+    # "G",        # flake8-logging-format
+    "PIE",      # flake8-pie
+    "Q",        # flake8-quotes
+    "RET",      # flake8-return
+    "SIM",      # flake8-simplify
+    "SLOT",     # flake8-slots
+    "PTH",      # flake8-use-pathlib
+    "FLY",      # flynt
+    "I",        # isort
+    "N",        # pep8-naming
+    "PERF",     # Perflint
+    "E",        # pycodestyle
+    "W",        # pycodestyle
+    "F",        # Pyflakes
+    "PL",       # Pylint
+    "UP",       # pyupgrade
+    "FURB",     # refurb
+    "RUF",      # Ruff-specific rules
+    "TRY",      # tryceratops
+    # "D",
+]
+ignore = [
+    "ANN401",   # any-type
+    "COM812",   # missing-trailing-comma
+    "D203",     # incorrect-blank-line-before-class
+    "PLR0911",  # too-many-return-statements
+    "PLR0912",  # too-many-branches
+    "PLR0913",  # too-many-arguments
+    "PLR0915",  # too-many-statements
+    "PLR2004",  # magic-value-comparison
+    "UP009",    # utf8-encoding-declaration
+    "TRY003",   # raise-vanilla-args
+    "D100",     # undocumented-public-module
+    "D104",     # undocumented-public-package
+    "D105",     # undocumented-magic-method
+    "D200",     # unnecessary-multiline-docstring
+    "D212",     # multi-line-summary-first-line
+    "D401",     # non-imperative-mood
+]

pyproject.toml

@@ -0,0 +1,16 @@
+#!/usr/bin/env python3
+
+import os
+
+
+def main() -> None:
+    if "container" in os.environ:
+        from ynh_dev.ynh_dev_guest import main_container  # noqa: PLC0415
+        main_container()
+    else:
+        from ynh_dev.ynh_dev_host import main_host  # noqa: PLC0415
+        main_host()
+
+
+if __name__ == "__main__":
+    main()

ynh-dev.py

@@ -0,0 +1,109 @@
+#!/usr/bin/python3
+
+import json
+import os
+import sys
+import time
+from collections import OrderedDict
+from pathlib import Path
+from typing import Any
+
+import toml
+import yaml
+
+my_env = os.environ.copy().update({"GIT_TERMINAL_PROMPT": "0"})
+
+
+class Catalog:
+    def __init__(self) -> None:
+        self.CATALOG_LIST_PATH = Path("/etc/yunohost/apps_catalog.yml")
+        self.DEFAULT_APPS_FOLDER = Path("/ynh-dev/custom-catalog/")
+        self.DEFAULT_APP_BRANCH = "master"
+        self.DEFAULT_CATALOG = [{"id": "default", "url": "https://app.yunohost.org/default/"}]
+        # assert self.CATALOG_LIST_PATH.exists(), f"Catalog list yaml file '{self.CATALOG_LIST_PATH} does not exists"
+
+    def build(self, folder: Path | None = None) -> None:
+        folder = folder or self.DEFAULT_APPS_FOLDER
+        assert folder.exists(), f"'{folder}' doesn't exist."
+        apps_list_path = folder / "apps.json"
+        assert apps_list_path.exists(), "no 'apps.json' app list found."
+        apps_list = json.load(apps_list_path.open())
+
+        apps = {}
+        fail = False
+
+        for app, infos in apps_list.items():
+            app = app.lower()
+            try:
+                app_dict = self.build_app_dict(app, infos, folder)
+            except Exception as e:
+                print(f"[\033[1m\033[31mFAIL\033[00m] Processing {app} failed: {e!s}")
+                fail = True
+                continue
+
+            apps[app_dict["id"]] = app_dict
+
+        # We also remove the app install question and resources parts which aint needed anymore by webadmin etc (or at least we think ;P)
+        for app in apps.values():
+            if "manifest" in app and "install" in app["manifest"]:
+                del app["manifest"]["install"]
+            if "manifest" in app and "resources" in app["manifest"]:
+                del app["manifest"]["resources"]
+
+        data = {
+            "apps": apps,
+            "from_api_version": 3,
+        }
+
+        output_file = folder / "catalog.json"
+        json.dump(data, output_file.open("w"), sort_keys=True, indent=2)
+
+        if fail:
+            sys.exit(1)
+
+    def build_app_dict(self, app: str, infos: dict[str, Any], folder: Path) -> dict[str, Any]:
+        app_folder = folder / f"{app}_ynh"
+
+        # Build the dict with all the infos
+        manifest_toml = app_folder / "manifest.toml"
+        manifest_json = app_folder / "manifest.json"
+        if manifest_toml.exists():
+            manifest = toml.load(manifest_toml.open(), _dict=OrderedDict)
+        else:
+            manifest = json.load(manifest_json.open(), _dict=OrderedDict)
+
+        return {
+            "id": app,
+            "git": {
+                "branch": infos.get("branch", self.DEFAULT_APP_BRANCH),
+                "revision": infos.get("revision", "HEAD"),
+                "url": f"file://{app_folder}",
+            },
+            "lastUpdate": time.time(),
+            "manifest": manifest,
+            "state": infos.get("state", "notworking"),
+            "level": infos.get("level", -1),
+            "maintained": infos.get("maintained", True),
+            # "high_quality": infos.get("high_quality", False),
+            # "featured": infos.get("featured", False),
+            "category": infos.get("category"),
+            "subtags": infos.get("subtags", []),
+            "potential_alternative_to": infos.get("potential_alternative_to", []),
+            "antifeatures": list(set(list(manifest.get("antifeatures", {}).keys()) + infos.get("antifeatures", []))),
+        }
+
+    def reset(self) -> None:
+        yaml.safe_dump(self.DEFAULT_CATALOG, self.CATALOG_LIST_PATH.open("w"), default_flow_style=False)
+
+    def add(self) -> None:
+        if not self.CATALOG_LIST_PATH.exists():
+            self.reset()
+        catalog_list = yaml.safe_load(self.CATALOG_LIST_PATH.open())
+        ids = [catalog["id"] for catalog in catalog_list]
+        if "custom" not in ids:
+            catalog_list.append({"id": "custom", "url": None})
+            yaml.safe_dump(catalog_list, self.CATALOG_LIST_PATH.open("w"), default_flow_style=False)
+
+    def override(self) -> None:
+        catalog_list = [{"id": "custom", "url": None}]
+        yaml.safe_dump(catalog_list, self.CATALOG_LIST_PATH.open("w"), default_flow_style=False)