アプリ
コアアプリクラス
reachy_mini.ReachyMiniApp
Reachy Mini アプリケーションの基底クラスです。
メソッド
run
アプリのメインロジックを実行します。
パラメータ:
| Name | Type | Description |
|---|---|---|
reachy_mini | ReachyMini | 操作対象の Reachy Mini インスタンス。 |
stop_event | threading.Event | アプリを安全に停止するためにセットできるイベント。 |
stop
アプリを安全に停止します。
wrapped_run
Reachy Mini のコンテキスト管理付きで run メソッドをラップして実行します。
reachy_mini.apps.manager.AppManager
Reachy Mini アプリのマネージャです。
メソッド
close
実行中のアプリを停止し、AppManager をクリーンアップします。
current_app_status
現在のアプリのステータスを取得します。
install_new_app
名前を指定して新しいアプリをインストールします。
is_app_running
アプリが現在実行中または停止処理中かどうかを確認します。
list_all_available_apps
利用可能なアプリを一覧表示します（並列非同期）。
list_available_apps
指定したソース種別に対して利用可能なアプリを一覧表示します。
remove_app
インストール済みのアプリを名前で削除します。
restart_current_app
現在のアプリを再起動します。
start_app
アプリをサブプロセスとして起動します。すでにアプリが実行中の場合は RuntimeError を送出します。
stop_current_app
現在のアプリのサブプロセスを停止します。
update_app
HuggingFace から再インストールすることで、インストール済みアプリを更新します。
元のソース情報を保持したまま再インストールし、最新バージョンを取得します。
パラメータ:
| Name | Type | Description |
|---|---|---|
app_name | str | 更新するアプリの名前。 |
logger | logging.Logger | 進行状況を出力するためのロガー。 |
アプリ管理
reachy_mini.apps.manager.AppState
実行中アプリの状態。
reachy_mini.apps.manager.AppStatus
アプリのステータス。
reachy_mini.apps.manager.RunningApp
実行中アプリに関する情報。
アプリ情報
reachy_mini.apps.AppInfo
アプリに関するメタデータ。
reachy_mini.apps.SourceKind
アプリソースの種類。
アプリアシスタント
アシスタント関数
reachy_mini.apps.assistant.validate_app_name
アプリ名を検証します。
reachy_mini.apps.assistant.is_git_repo
指定されたパスが git リポジトリ内かどうかを確認します。
reachy_mini.apps.assistant.validate_location
アプリプロジェクトを作成する場所を検証します。
reachy_mini.apps.assistant.validate_location_and_git_repo
アプリプロジェクトを作成する場所を検証し、git リポジトリ内でないことを保証します。
reachy_mini.apps.assistant.create_cli
CLI を使用して新しい Reachy Mini アプリプロジェクトを作成します。
reachy_mini.apps.assistant.create
指定された名前とパスで新しい Reachy Mini アプリプロジェクトを作成します。
パラメータ:
| Name | Type | Description |
|---|---|---|
console | Console | メッセージを表示するためのコンソールオブジェクト。 |
app_name | str | 作成するアプリの名前。 |
app_path | Path | アプリプロジェクトを作成するディレクトリ。 |
戻り値:
| Type | Description |
|---|---|
Path | 作成されたアプリプロジェクトへのパス。 |
reachy_mini.apps.assistant.install_app_with_progress
一時的な仮想環境にアプリをインストールし、プログレススピナーを表示します。
reachy_mini.apps.assistant.check
既存の Reachy Mini アプリプロジェクトをチェックします。
パラメータ:
| Name | Type | Description |
|---|---|---|
console | Console | メッセージを表示するためのコンソールオブジェクト。 |
app_path | str | チェック対象アプリへのローカルパス。 |
reachy_mini.apps.assistant.request_app_addition
新しいアプリを公式 Reachy Mini アプリストアに追加するようリクエストします。
reachy_mini.apps.assistant.try_to_push
変更をリモートリポジトリに push しようとします。
reachy_mini.apps.assistant.publish
アプリを Reachy Mini アプリストアに公開します。
パラメータ:
| Name | Type | Description |
|---|---|---|
console | Console | メッセージを表示するためのコンソールオブジェクト。 |
app_path | str | 公開するアプリへのローカルパス。 |
commit_message | str | アプリ公開用のコミットメッセージ。 |
official | bool | アプリを公式 Reachy Mini アプリとして公開するかどうかのリクエスト。 |
no_check | bool | 公開前のチェックを実行しない場合は True。 |
private | bool | None | True の場合は非公開、False の場合は公開、None の場合はプロンプトで確認。 |
アプリソース
reachy_mini.apps.sources.hf_auth.save_hf_token
HuggingFace アクセストークンを安全に保存します。
トークンを Hugging Face API に対して検証し、有効な場合は標準の Hugging Face 認証メカニズムを用いて保存し、セッション間で再利用できるようにします。
パラメータ:
| Name | Type | Description |
|---|---|---|
token | str | 保存する HuggingFace アクセストークン。 |
戻り値:
| Type | Description |
|---|---|
dict | 次を含む dict: "status"（"success" または "error"）、"username"（成功時の関連付けられた Hugging Face ユーザー名）、"message"（失敗時のエラー内容）。 |
reachy_mini.apps.sources.hf_auth.get_hf_token
保存済みの HuggingFace トークンを取得します。
戻り値:
| Type | Description |
|---|---|
str | None | 保存されているトークン。トークンがない場合は None。 |
reachy_mini.apps.sources.hf_auth.delete_hf_token
保存されている HuggingFace トークンを削除します。
引数なしの logout() は、保存されているすべてのアクセストークンからログアウトします。
reachy_mini.apps.sources.hf_auth.check_token_status
トークンが保存されており有効かどうかを確認します。
戻り値:
| Type | Description |
|---|---|
dict | is_logged_in と username を含むステータス dict。 |
reachy_mini.apps.sources.hf_space.list_available_apps
Hugging Face Spaces で利用可能なアプリを一覧表示します。
reachy_mini.apps.sources.hf_space.list_all_apps
Hugging Face Spaces で利用可能なすべてのアプリ（非公式なものも含む）を一覧表示します。
reachy_mini.apps.sources.local_common_venv.get_app_site_packages
指定されたアプリの venv に対する site-packages ディレクトリを取得するための公開 API です。
- 個別の venv の場合：アプリの venv の site-packages を返します
- 共有環境（SDK モード）の場合：現在の環境の site-packages を返します
reachy_mini.apps.sources.local_common_venv.get_app_python
アプリ用の Python 実行ファイルのパスを取得します（クロスプラットフォーム）。
- 個別の venv の場合：アプリの venv の Python を返します
- 共有環境の場合：現在の Python インタプリタを返します
reachy_mini.apps.sources.local_common_venv.list_available_apps
エントリポイントまたは個別の venv から利用可能なアプリを一覧表示します。
reachy_mini.apps.sources.local_common_venv.install_package
AppInfo オブジェクトを指定してパッケージをインストールし、ログをストリーミングします。
パラメータ:
| 名前 | 型 | 説明 |
|---|---|---|
app | AppInfo | パッケージの詳細を含む AppInfo。 |
logger | logging.Logger | 進行状況を出力するためのロガー。 |
wireless_version | bool | ワイヤレス版で実行しているかどうか。 |
desktop_app_daemon | bool | デスクトップアプリのデーモンとして実行しているかどうか。 |
force_reinstall | bool | True の場合、すでにインストール済みでも（アップデートのために）再インストールを強制します。 |
reachy_mini.apps.sources.local_common_venv.get_app_module
サブプロセス実行用に、アプリをロードせずにモジュール名を取得します。
reachy_mini.apps.sources.local_common_venv.uninstall_package
アプリ名を指定してパッケージをアンインストールします。
アプリユーティリティ
reachy_mini.apps.utils.running_command
シェルコマンドを実行し、その出力を指定されたロガーにストリーミングします。