ruyi 0.41.0a20250911__tar.gz → 0.41.0b20250924__tar.gz

{ruyi-0.41.0a20250911 → ruyi-0.41.0b20250924}/PKG-INFO

@@ -1,6 +1,6 @@
-Metadata-Version: 2.3
+Metadata-Version: 2.4
 Name: ruyi
-Version: 0.41.0a20250911
+Version: 0.41.0b20250924
 Summary: Package manager for RuyiSDK
 License: Apache License
                                     Version 2.0, January 2004
@@ -203,6 +203,7 @@ License: Apache License
             WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
             See the License for the specific language governing permissions and
             limitations under the License.
+License-File: LICENSE-Apache.txt
 Keywords: ruyi,ruyisdk
 Author: WANG Xuerui
 Author-email: wangxuerui@iscas.ac.cn
@@ -271,6 +272,8 @@ PyPI installation, but the one-file distribution is a bit easier to set up
 because one doesn't have to first configure a Python environment. Either way,
 the feature set should be the same.
 
+Detailed installation instructions are also available [at our documentation site](https://ruyisdk.org/en/docs/Package-Manager/installation).
+
 ### ✅ Recommended: Install from PyPI
 
 This is the recommended way to install `ruyi` on your machine. In any Python
@@ -431,8 +434,6 @@ We collect the following information with `ruyi`:
     * without exposing any parameters
     * invocation time is recorded with a granularity of 1 minute
 
-You can see our Privacy Policy on the RuyiSDK website.
-
 You can see [our Privacy Policy][privacy-policy-en] ([中文][privacy-policy-zh])
 on the RuyiSDK website.
 

{ruyi-0.41.0a20250911 → ruyi-0.41.0b20250924}/README.md

@@ -28,6 +28,8 @@ PyPI installation, but the one-file distribution is a bit easier to set up
 because one doesn't have to first configure a Python environment. Either way,
 the feature set should be the same.
 
+Detailed installation instructions are also available [at our documentation site](https://ruyisdk.org/en/docs/Package-Manager/installation).
+
 ### ✅ Recommended: Install from PyPI
 
 This is the recommended way to install `ruyi` on your machine. In any Python
@@ -188,8 +190,6 @@ We collect the following information with `ruyi`:
     * without exposing any parameters
     * invocation time is recorded with a granularity of 1 minute
 
-You can see our Privacy Policy on the RuyiSDK website.
-
 You can see [our Privacy Policy][privacy-policy-en] ([中文][privacy-policy-zh])
 on the RuyiSDK website.
 

{ruyi-0.41.0a20250911 → ruyi-0.41.0b20250924}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "poetry.core.masonry.api"
 
 [project]
 name = "ruyi"
-version = "0.41.0-alpha.20250911"
+version = "0.41.0-beta.20250924"
 description = "Package manager for RuyiSDK"
 keywords = ["ruyi", "ruyisdk"]
 license = { file = "LICENSE-Apache.txt" }

{ruyi-0.41.0a20250911 → ruyi-0.41.0b20250924}/ruyi/cli/cmd.py

@@ -198,7 +198,9 @@ class RootCommand(
             return 0
         # the rest are implementation of "--output-completion-script"
 
-        if sh not in {"bash", "zsh"}:
+        from .completion import SUPPORTED_SHELLS
+
+        if sh not in SUPPORTED_SHELLS:
             raise ValueError(f"Unsupported shell: {sh}")
 
         import sys

{ruyi-0.41.0a20250911 → ruyi-0.41.0b20250924}/ruyi/cli/completion.py

@@ -5,7 +5,9 @@ see https://github.com/kislyuk/argcomplete/issues/443 for why this is needed
 """
 
 import argparse
-from typing import Any, Callable, Optional, Sequence, cast
+from typing import Any, Callable, Final, Optional, Sequence, cast
+
+SUPPORTED_SHELLS: Final[set[str]] = {"bash", "zsh"}
 
 
 class ArgcompleteAction(argparse.Action):

{ruyi-0.41.0a20250911 → ruyi-0.41.0b20250924}/ruyi/cli/main.py

@@ -7,6 +7,7 @@ from ..config import GlobalConfig
 from ..telemetry.scope import TelemetryScope
 from ..utils.global_mode import GlobalModeProvider
 from . import RUYI_ENTRYPOINT_NAME
+from .oobe import OOBE
 
 ALLOWED_RUYI_ENTRYPOINT_NAMES: Final = (
     RUYI_ENTRYPOINT_NAME,
@@ -21,11 +22,15 @@ def is_called_as_ruyi(argv0: str) -> bool:
 
 
 def main(gm: GlobalModeProvider, gc: GlobalConfig, argv: list[str]) -> int:
+    oobe = OOBE(gc)
+
     if tm := gc.telemetry:
         tm.check_first_run_status()
         tm.init_installation(False)
         atexit.register(tm.flush)
-        tm.maybe_prompt_for_first_run_upload()
+        oobe.handlers.append(tm.oobe_prompt)
+
+    oobe.maybe_prompt()
 
     if not is_called_as_ruyi(gm.argv0):
         from ..mux.runtime import mux_main

ruyi-0.41.0b20250924/ruyi/cli/oobe.py

@@ -0,0 +1,79 @@
+"""First-run (Out-of-the-box) experience for ``ruyi``."""
+
+import os
+import sys
+from typing import Callable, TYPE_CHECKING
+
+if TYPE_CHECKING:
+    from ..config import GlobalConfig
+
+
+SHELL_AUTO_COMPLETION_TIP = """
+[bold green]tip[/]: you can enable shell auto-completion for [yellow]ruyi[/] by adding the
+following line to your [green]{shrc}[/], if you have not done so already:
+
+    [green]eval "$(ruyi --output-completion-script={shell})"[/]
+
+You can do so by running the following command later:
+
+    [green]echo 'eval "$(ruyi --output-completion-script={shell})"' >> {shrc}[/]
+"""
+
+
+class OOBE:
+    """Out-of-the-box experience (OOBE) handler for RuyiSDK CLI."""
+
+    def __init__(self, gc: "GlobalConfig") -> None:
+        self._gc = gc
+        self.handlers: list[Callable[[], None]] = [
+            self._builtin_shell_completion_tip,
+        ]
+
+    def is_first_run(self) -> bool:
+        if tm := self._gc.telemetry:
+            return tm.is_first_run
+        # cannot reliably determine first run status without telemetry
+        # we may revisit this later if it turns out users want OOBE tips even
+        # if they know how to disable telemetry (hence more likely to be power
+        # users)
+        return False
+
+    def should_prompt(self) -> bool:
+        from ..utils.global_mode import is_env_var_truthy
+
+        if is_env_var_truthy(os.environ, "RUYI_DEBUG_FORCE_FIRST_RUN"):
+            return True
+
+        return self.is_first_run() and sys.stdin.isatty()
+
+    def maybe_prompt(self) -> None:
+        if not self.should_prompt():
+            return
+
+        logger = self._gc.logger
+        logger.I(
+            "Welcome to RuyiSDK! This appears to be your first run of [yellow]ruyi[/].",
+        )
+
+        for handler in self.handlers:
+            handler()
+
+    def _builtin_shell_completion_tip(self) -> None:
+        from ..telemetry.node_info import probe_for_shell
+        from .completion import SUPPORTED_SHELLS
+
+        # Only show the tip if we're not externally managed by a package manager,
+        # because we expect proper shell integration to be done by distro packagers
+        if self._gc.is_installation_externally_managed:
+            return
+
+        shell = probe_for_shell(os.environ)
+        if shell not in SUPPORTED_SHELLS:
+            return
+
+        self._gc.logger.stdout(
+            SHELL_AUTO_COMPLETION_TIP.format(
+                shell=shell,
+                shrc=f"~/.{shell}rc",
+            )
+        )

{ruyi-0.41.0a20250911 → ruyi-0.41.0b20250924}/ruyi/device/provision.py

@@ -15,7 +15,7 @@ from ..ruyipkg.pkg_manifest import (
     PartitionMapDecl,
 )
 from ..ruyipkg.repo import MetadataRepo
-from ..utils import prereqs
+from ..utils import mounts, prereqs
 
 if TYPE_CHECKING:
     from ..ruyipkg.pkg_manifest import BoundPackageManifest
@@ -209,10 +209,31 @@ information you will need later.
         )
         for part in requested_host_blkdevs:
             part_desc = get_part_desc(part)
-            path = user_input.ask_for_file(
-                logger,
-                f"Please give the path for the {part_desc}:",
-            )
+
+            while True:
+                path = user_input.ask_for_file(
+                    logger,
+                    f"Please give the path for the {part_desc}:",
+                )
+
+                # Retrieve the latest mount info in case the user un-mounts
+                # on seeing the prompt
+                all_mounts = mounts.parse_mounts()
+                blkdev_mounts = [m for m in all_mounts if m.source_is_blkdev]
+                path_valid = True
+                for m in blkdev_mounts:
+                    if m.source_path.samefile(path):
+                        logger.W(
+                            f"path [cyan]'{path}'[/] is currently mounted at [yellow]'{m.target}'[/]"
+                        )
+                        logger.I(
+                            "rejecting the path for safety; please double-check and retry"
+                        )
+                        path_valid = False
+                        break
+                if path_valid:
+                    break
+
             host_blkdev_map[part] = path
 
     # final confirmation

{ruyi-0.41.0a20250911 → ruyi-0.41.0b20250924}/ruyi/ruyipkg/news.py

@@ -32,6 +32,25 @@ def print_news_item_titles(
     logger.stdout(tbl)
 
 
+def maybe_notify_unread_news(
+    gc: GlobalConfig,
+    prompt_no_unread: bool = True,
+) -> None:
+    """Check if there are new newsitems, notify the user if so."""
+
+    unread_newsitems = gc.repo.news_store().list(True)
+    if unread_newsitems:
+        gc.logger.stdout(f"\nThere are {len(unread_newsitems)} new news item(s):\n")
+        print_news_item_titles(gc.logger, unread_newsitems, gc.lang_code)
+        gc.logger.stdout("\nYou can read them with [yellow]ruyi news read[/].")
+        return
+
+    if prompt_no_unread:
+        gc.logger.stdout(
+            "\nAll news items have been read. To see a list of them, run [yellow]ruyi news list[/].\n"
+        )
+
+
 def do_news_list(
     cfg: GlobalConfig,
     only_unread: bool,

{ruyi-0.41.0a20250911 → ruyi-0.41.0b20250924}/ruyi/ruyipkg/news_cli.py

@@ -12,11 +12,25 @@ class NewsCommand(
     RootCommand,
     cmd="news",
     has_subcommands=True,
+    is_subcommand_required=False,
+    has_main=True,
     help="List and read news items from configured repository",
 ):
+    _my_parser: "ArgumentParser | None" = None
+
     @classmethod
     def configure_args(cls, gc: "GlobalConfig", p: "ArgumentParser") -> None:
-        pass
+        cls._my_parser = p
+
+    @classmethod
+    def main(cls, cfg: "GlobalConfig", args: argparse.Namespace) -> int:
+        from .news import maybe_notify_unread_news
+
+        assert cls._my_parser is not None
+        cls._my_parser.print_help()
+        maybe_notify_unread_news(cfg, True)
+
+        return 0
 
 
 class NewsListCommand(

{ruyi-0.41.0a20250911 → ruyi-0.41.0b20250924}/ruyi/ruyipkg/repo.py

@@ -284,7 +284,8 @@ class MetadataRepo(ProvidesPackageManifests):
             self.repo = Repository(self.root)
             return self.repo
 
-        self.logger.D(f"{self.root} does not exist, cloning from {self.remote}")
+        self.logger.I(f"the package repository does not exist at [yellow]{self.root}[/]")
+        self.logger.I(f"cloning from [cyan link={self.remote}]{self.remote}[/]")
 
         with RemoteGitProgressIndicator() as pr:
             repo = clone_repository(
@@ -306,13 +307,15 @@ class MetadataRepo(ProvidesPackageManifests):
         return self.repo
 
     def sync(self) -> None:
+        self._gc.logger.I("updating the package repository")
+
         repo = self.ensure_git_repo()
 
         # only manage the repo settings on the user's behalf if the user
         # has not overridden the repo directory themselves
         allow_auto_management = self._gc.override_repo_dir is None
 
-        return pull_ff_or_die(
+        pull_ff_or_die(
             self.logger,
             repo,
             "origin",
@@ -321,6 +324,8 @@ class MetadataRepo(ProvidesPackageManifests):
             allow_auto_management=allow_auto_management,
         )
 
+        self._gc.logger.I("package repository is updated")
+
     @property
     def global_config(self) -> "GlobalConfig":
         return self._gc

{ruyi-0.41.0a20250911 → ruyi-0.41.0b20250924}/ruyi/ruyipkg/update_cli.py

@@ -44,11 +44,6 @@ Re-run [yellow]ruyi install[/] to upgrade, and don't forget to re-create any aff
 virtual environments."""
             )
 
-        # check if there are new newsitems
-        unread_newsitems = mr.news_store().list(True)
-        if unread_newsitems:
-            logger.stdout(f"\nThere are {len(unread_newsitems)} new news item(s):\n")
-            news.print_news_item_titles(logger, unread_newsitems, cfg.lang_code)
-            logger.stdout("\nYou can read them with [yellow]ruyi news read[/].")
+        news.maybe_notify_unread_news(cfg, False)
 
         return 0

{ruyi-0.41.0a20250911 → ruyi-0.41.0b20250924}/ruyi/telemetry/provider.py

@@ -3,7 +3,6 @@ import datetime
 import functools
 import json
 import pathlib
-import sys
 import time
 from typing import Callable, TYPE_CHECKING, cast
 import uuid
@@ -19,9 +18,7 @@ if TYPE_CHECKING:
 
 FALLBACK_PM_TELEMETRY_ENDPOINT = "https://api.ruyisdk.cn/telemetry/pm/"
 
-FIRST_RUN_PROMPT = """\
-Welcome to RuyiSDK! This appears to be your first run of [yellow]ruyi[/].
-
+TELEMETRY_INITIAL_UPLOAD_PROMPT = """
 By default, the RuyiSDK team collects anonymous usage data to help us improve
 the product. No personal information or detail about your project is ever
 collected. The data will be uploaded to RuyiSDK team-managed servers located
@@ -388,19 +385,12 @@ class TelemetryProvider:
 
         return store.upload_staged_payloads()
 
-    def maybe_prompt_for_first_run_upload(self) -> None:
-        """
-        Ask whether the user consents to a first-run telemetry upload when
-        running for the first time (OOBE) and with an interactive stdin.
-        """
-
-        # Only prompt if this is first run and stdin is a TTY
-        if not (self.is_first_run and sys.stdin.isatty()):
-            return
+    def oobe_prompt(self) -> None:
+        """Ask whether the user consents to a first-run telemetry upload."""
 
         from ..cli import user_input
 
-        self.logger.I(FIRST_RUN_PROMPT)
+        self.logger.stdout(TELEMETRY_INITIAL_UPLOAD_PROMPT)
         if not user_input.ask_for_yesno_confirmation(
             self.logger,
             "Do you agree?",

ruyi-0.41.0b20250924/ruyi/utils/mounts.py

@@ -0,0 +1,45 @@
+"""Utilities for parsing mount information from /proc/self/mounts."""
+
+import pathlib
+import re
+from typing import NamedTuple
+
+
+class MountInfo(NamedTuple):
+    source: str
+    target: str
+    fstype: str
+    options: list[str]
+
+    @property
+    def source_path(self) -> pathlib.Path:
+        return pathlib.Path(self.source)
+
+    @property
+    def source_is_blkdev(self) -> bool:
+        return self.source_path.is_block_device()
+
+
+def parse_mounts(contents: str | None = None) -> list[MountInfo]:
+    if contents is None:
+        try:
+            with open("/proc/self/mounts", "r", encoding="utf-8") as f:
+                contents = f.read()
+        except OSError:
+            return []
+
+    mounts: list[MountInfo] = []
+    for line in contents.splitlines():
+        parts = line.split()
+        if len(parts) < 4:
+            continue
+        source, target, fstype, opts = parts[:4]
+        options = opts.split(",")
+        source = _unescape_octals(source)
+        target = _unescape_octals(target)
+        mounts.append(MountInfo(source, target, fstype, options))
+    return mounts
+
+
+def _unescape_octals(s: str) -> str:
+    return re.sub(r"\\([0-3][0-7]{2})", lambda m: chr(int(m.group(1), 8)), s)