reachy_mini/pr_1321/en/API/apps.md

Apps

Core App Classes[[reachy_mini.ReachyMiniApp]]

reachy_mini.ReachyMiniApp[[reachy_mini.ReachyMiniApp]]

reachy_mini.ReachyMiniApp(running_on_wireless: bool = False)

Source

Base class for Reachy Mini applications.

run[[reachy_mini.ReachyMiniApp.run]]

run(reachy_mini: ReachyMini, stop_event: Event)

Source

Parameters:

reachy_mini (ReachyMini) : The Reachy Mini instance to interact with.

stop_event (threading.Event) : An event that can be set to stop the app gracefully.

Run the main logic of the app.

stop[[reachy_mini.ReachyMiniApp.stop]]

stop()

Source

Stop the app gracefully.

wrapped_run[[reachy_mini.ReachyMiniApp.wrapped_run]]

wrapped_run(*args: Any, **kwargs: Any)

Source

Wrap the run method with Reachy Mini context management.

reachy_mini.apps.manager.AppManager[[reachy_mini.apps.manager.AppManager]]

reachy_mini.apps.manager.AppManager(wireless_version: bool = False, desktop_app_daemon: bool = False, daemon: typing.Optional[ForwardRef('Daemon')] = None)

Source

Manager for Reachy Mini apps.

close[[reachy_mini.apps.manager.AppManager.close]]

close()

Source

Clean up the AppManager, stopping any running app.

current_app_status[[reachy_mini.apps.manager.AppManager.current_app_status]]

current_app_status()

Source

Get the current status of the app.

get_running_app_url[[reachy_mini.apps.manager.AppManager.get_running_app_url]]

get_running_app_url()

Source

Return the running app's custom_app_url, or None.

The JSON-RPC relay uses this to reach the app's /rpc endpoint. The URL is read from the app's main.py (same cheap scrape the launcher uses); the relay normalizes the host (0.0.0.0 -> 127.0.0.1).

install_new_app[[reachy_mini.apps.manager.AppManager.install_new_app]]

install_new_app(app: AppInfo, logger: Logger)

Source

Install a new app by name.

is_app_running[[reachy_mini.apps.manager.AppManager.is_app_running]]

is_app_running()

Source

Check if an app is currently running or stopping.

list_all_available_apps[[reachy_mini.apps.manager.AppManager.list_all_available_apps]]

list_all_available_apps()

Source

List available apps while preserving curated-only entries.

list_available_apps[[reachy_mini.apps.manager.AppManager.list_available_apps]]

list_available_apps(source: SourceKind)

Source

List available apps for given source kind.

remove_app[[reachy_mini.apps.manager.AppManager.remove_app]]

remove_app(app_name: str, logger: Logger)

Source

Remove an installed app by name.

restart_current_app[[reachy_mini.apps.manager.AppManager.restart_current_app]]

restart_current_app()

Source

Restart the current app.

start_app[[reachy_mini.apps.manager.AppManager.start_app]]

start_app(app_name: str, *args: Any, evict_remote: bool = True, keep_remote: bool = False, **kwargs: Any)

Source

Start the app as a subprocess.

Raises RuntimeError if an app is already running. When evict_remote is false, a remote WebRTC session holding the app slot makes the start fail instead of being evicted.

keep_remote (used when the start is requested by the connected remote client, e.g. the mobile app driving a conversation) takes the local-app slot without evicting the remote session: the client is a controller of this app, not a competitor for the robot, so its DataChannel must survive. Takes precedence over evict_remote.

stop_current_app[[reachy_mini.apps.manager.AppManager.stop_current_app]]

stop_current_app(timeout: float | None = 20.0)

Source

Stop the current app subprocess.

update_app[[reachy_mini.apps.manager.AppManager.update_app]]

update_app(app_name: str, logger: Logger)

Source

Parameters:

app_name : Name of the app to update.

logger : Logger for progress output.

Raises: RuntimeError

• RuntimeError -- If app is running, not found, or update fails.

Update an installed app by reinstalling it from HuggingFace.

This preserves the original source info and reinstalls to get the latest version.

App Management[[reachy_mini.apps.manager.AppState]]

reachy_mini.apps.manager.AppState[[reachy_mini.apps.manager.AppState]]

reachy_mini.apps.manager.AppState(value, names = None, module = None, qualname = None, type = None, start = 1, boundary = None)

Source

Status of a running app.

reachy_mini.apps.manager.AppStatus[[reachy_mini.apps.manager.AppStatus]]

reachy_mini.apps.manager.AppStatus(info: AppInfo, state: AppState, error: str | None = None)

Source

Status of an app.

reachy_mini.apps.manager.RunningApp[[reachy_mini.apps.manager.RunningApp]]

reachy_mini.apps.manager.RunningApp(process: Process, monitor_task: Task, status: AppStatus)

Source

Information about a running app.

App Information[[reachy_mini.apps.AppInfo]]

reachy_mini.apps.AppInfo[[reachy_mini.apps.AppInfo]]

reachy_mini.apps.AppInfo(name: str, source_kind: SourceKind, description: str = '', url: str | None = None, extra: typing.Dict[str, typing.Any] = <factory>)

Source

Metadata about an app.

reachy_mini.apps.SourceKind[[reachy_mini.apps.SourceKind]]

reachy_mini.apps.SourceKind(value, names = None, module = None, qualname = None, type = None, start = 1, boundary = None)

Source

Kinds of app source.

App Assistant

Assistant Functions[[reachy_mini.apps.assistant.validate_app_name]]

reachy_mini.apps.assistant.validate_app_name[[reachy_mini.apps.assistant.validate_app_name]]

reachy_mini.apps.assistant.validate_app_name(text: str)

Source

Validate the app name.

reachy_mini.apps.assistant.is_git_repo[[reachy_mini.apps.assistant.is_git_repo]]

reachy_mini.apps.assistant.is_git_repo(path: Path)

Source

Check if the given path is inside a git repository.

reachy_mini.apps.assistant.validate_location[[reachy_mini.apps.assistant.validate_location]]

reachy_mini.apps.assistant.validate_location(text: str)

Source

Validate the location where to create the app project.

reachy_mini.apps.assistant.validate_location_and_git_repo[[reachy_mini.apps.assistant.validate_location_and_git_repo]]

reachy_mini.apps.assistant.validate_location_and_git_repo(text: str)

Source

Validate the location where to create the app project, ensuring it's not in a git repo.

reachy_mini.apps.assistant.create_cli[[reachy_mini.apps.assistant.create_cli]]

reachy_mini.apps.assistant.create_cli(console: Console, app_name: str | None, app_path: pathlib.Path | None)

Source

Create a new Reachy Mini app project using a CLI.

reachy_mini.apps.assistant.create[[reachy_mini.apps.assistant.create]]

reachy_mini.apps.assistant.create(console: Console, app_name: str, app_path: Path)

Source

Parameters:

console (Console) : The console object for printing messages.

app_name (str) : The name of the app to create.

app_path (Path) : The directory where the app project will be created.

Returns: Path

The path to the created app project.

Create a new Reachy Mini app project with the given name at the specified path.

reachy_mini.apps.assistant.install_app_with_progress[[reachy_mini.apps.assistant.install_app_with_progress]]

reachy_mini.apps.assistant.install_app_with_progress(console: Console, python_executable: str, app_path: Path, env: dict[str, str] | None = None)

Source

Install the app in a temporary virtual environment with a progress spinner.

reachy_mini.apps.assistant.check[[reachy_mini.apps.assistant.check]]

reachy_mini.apps.assistant.check(console: Console, app_path: str)

Source

Parameters:

console (Console) : The console object for printing messages.

app_path (str) : Local path to the app to check.

Check an existing Reachy Mini app project.

reachy_mini.apps.assistant.request_app_addition[[reachy_mini.apps.assistant.request_app_addition]]

reachy_mini.apps.assistant.request_app_addition(new_app_repo_id: str)

Source

Request to add the new app to the official Reachy Mini app store.

reachy_mini.apps.assistant.try_to_push[[reachy_mini.apps.assistant.try_to_push]]

reachy_mini.apps.assistant.try_to_push(console: Console, _app_path: Path)

Source

Try to push changes to the remote repository.

reachy_mini.apps.assistant.publish[[reachy_mini.apps.assistant.publish]]

reachy_mini.apps.assistant.publish(console: Console, app_path: str, commit_message: str, official: bool = False, no_check: bool = False, private: bool | None = None)

Source

Parameters:

console (Console) : The console object for printing messages.

app_path (str) : Local path to the app to publish.

commit_message (str) : Commit message for the app publish.

official (bool) : Request to publish the app as an official Reachy Mini app.

no_check (bool) : Don't run checks before publishing the app.

private (bool | None) : If True, make private. If False, make public. If None, prompt.

Publish the app to the Reachy Mini app store.

App Sources[[reachy_mini.apps.sources.hf_auth.save_hf_token]]

reachy_mini.apps.sources.hf_auth.save_hf_token[[reachy_mini.apps.sources.hf_auth.save_hf_token]]

reachy_mini.apps.sources.hf_auth.save_hf_token(token: str)

Source

Parameters:

token : The HuggingFace access token to save.

Returns: A dict containing

• "status": "success" or "error"
• "username": the associated Hugging Face username if successful
• "message": an error description if unsuccessful

Save a HuggingFace access token securely.

Validates the token against the Hugging Face API and, if valid, stores it using the standard Hugging Face authentication mechanism for reuse across sessions.

reachy_mini.apps.sources.hf_auth.get_hf_token[[reachy_mini.apps.sources.hf_auth.get_hf_token]]

reachy_mini.apps.sources.hf_auth.get_hf_token()

Source

Returns:

The stored token, or None if no token is stored.

Get stored HuggingFace token.

reachy_mini.apps.sources.hf_auth.delete_hf_token[[reachy_mini.apps.sources.hf_auth.delete_hf_token]]

reachy_mini.apps.sources.hf_auth.delete_hf_token()

Source

Delete stored HuggingFace token(s).

Note: logout() without arguments logs out from all saved access tokens.

reachy_mini.apps.sources.hf_auth.check_token_status[[reachy_mini.apps.sources.hf_auth.check_token_status]]

reachy_mini.apps.sources.hf_auth.check_token_status()

Source

Returns:

Status dict with is_logged_in and username.

Check if a token is stored and valid.

reachy_mini.apps.sources.hf_space.list_available_apps[[reachy_mini.apps.sources.hf_space.list_available_apps]]

reachy_mini.apps.sources.hf_space.list_available_apps()

Source

List apps available on Hugging Face Spaces.

reachy_mini.apps.sources.hf_space.list_all_apps[[reachy_mini.apps.sources.hf_space.list_all_apps]]

reachy_mini.apps.sources.hf_space.list_all_apps()

Source

List all apps available on Hugging Face Spaces (including private ones when authenticated).

reachy_mini.apps.sources.local_common_venv.get_app_site_packages[[reachy_mini.apps.sources.local_common_venv.get_app_site_packages]]

reachy_mini.apps.sources.local_common_venv.get_app_site_packages(app_name: str, wireless_version: bool = False, desktop_app_daemon: bool = False)

Source

Public API to get the site-packages directory for a given app's venv.

For separate venvs: returns the app's venv site-packages For shared environment (SDK mode): returns the current environment's site-packages

reachy_mini.apps.sources.local_common_venv.get_app_python[[reachy_mini.apps.sources.local_common_venv.get_app_python]]

reachy_mini.apps.sources.local_common_venv.get_app_python(app_name: str, wireless_version: bool = False, desktop_app_daemon: bool = False)

Source

Get the Python executable path for an app (cross-platform).

For separate venvs: returns the app's venv Python For shared environment: returns the current Python interpreter

reachy_mini.apps.sources.local_common_venv.list_available_apps[[reachy_mini.apps.sources.local_common_venv.list_available_apps]]

reachy_mini.apps.sources.local_common_venv.list_available_apps(wireless_version: bool = False, desktop_app_daemon: bool = False)

Source

List apps available from entry points or separate venvs.

reachy_mini.apps.sources.local_common_venv.install_package[[reachy_mini.apps.sources.local_common_venv.install_package]]

reachy_mini.apps.sources.local_common_venv.install_package(app: AppInfo, logger: Logger, wireless_version: bool = False, desktop_app_daemon: bool = False, force_reinstall: bool = False)

Source

Parameters:

app : AppInfo with package details.

logger : Logger for progress output.

wireless_version : Whether running on wireless version.

desktop_app_daemon : Whether running as desktop app daemon.

force_reinstall : If True, force reinstall even if already installed (for updates).

Install a package given an AppInfo object, streaming logs.

reachy_mini.apps.sources.local_common_venv.get_app_module[[reachy_mini.apps.sources.local_common_venv.get_app_module]]

reachy_mini.apps.sources.local_common_venv.get_app_module(app_name: str, wireless_version: bool = False, desktop_app_daemon: bool = False)

Source

Get the module name for an app without loading it (for subprocess execution).

reachy_mini.apps.sources.local_common_venv.uninstall_package[[reachy_mini.apps.sources.local_common_venv.uninstall_package]]

reachy_mini.apps.sources.local_common_venv.uninstall_package(app_name: str, logger: Logger, wireless_version: bool = False, desktop_app_daemon: bool = False)

Source

Uninstall a package given an app name.

App Utilities[[reachy_mini.apps.utils.running_command]]

reachy_mini.apps.utils.running_command[[reachy_mini.apps.utils.running_command]]

reachy_mini.apps.utils.running_command(command: list, logger: Logger, env: dict[str, str] | None = None)

Source

Parameters:

command : The command to run as a list of strings.

logger : Logger instance for output streaming.

env : Optional environment variables dict. If None, inherits current environment.

Run a shell command and stream its output to the provided logger.