Apps
Classes Centrais de App
reachy_mini.ReachyMiniApp
Classe base para aplicações Reachy Mini.
Métodos
run
Executa a lógica principal do app.
Parâmetros:
| Nome | Tipo | Descrição |
|---|---|---|
reachy_mini | ReachyMini | A instância Reachy Mini com a qual interagir. |
stop_event | threading.Event | Um evento que pode ser definido para parar o app de forma graciosa. |
stop
Interrompe o app de forma graciosa.
wrapped_run
Encapsula o método run com o gerenciamento de contexto do Reachy Mini.
reachy_mini.apps.manager.AppManager
Gerenciador para apps Reachy Mini.
Métodos
close
Limpa o AppManager, interrompendo qualquer app em execução.
current_app_status
Obtém o status atual do app.
install_new_app
Instala um novo app pelo nome.
is_app_running
Verifica se um app está atualmente em execução ou sendo interrompido.
list_all_available_apps
Lista apps disponíveis (async paralelo).
list_available_apps
Lista apps disponíveis para um tipo de fonte fornecido.
remove_app
Remove um app instalado pelo nome.
restart_current_app
Reinicia o app atual.
start_app
Inicia o app como um subprocesso, lança RuntimeError se um app já estiver em execução.
stop_current_app
Interrompe o subprocesso do app atual.
update_app
Atualiza um app instalado reinstalando-o a partir do HuggingFace.
Isso preserva as informações de fonte originais e reinstala para obter a versão mais recente.
Parâmetros:
| Nome | Tipo | Descrição |
|---|---|---|
app_name | str | Nome do app a ser atualizado. |
logger | logging.Logger | Logger para saída de progresso. |
Gerenciamento de App
reachy_mini.apps.manager.AppState
Status de um app em execução.
reachy_mini.apps.manager.AppStatus
Status de um app.
reachy_mini.apps.manager.RunningApp
Informações sobre um app em execução.
Informações de App
reachy_mini.apps.AppInfo
Metadados sobre um app.
reachy_mini.apps.SourceKind
Tipos de fonte de app.
Assistente de App
Funções do Assistente
reachy_mini.apps.assistant.validate_app_name
Valida o nome do app.
reachy_mini.apps.assistant.is_git_repo
Verifica se o caminho fornecido está dentro de um repositório git.
reachy_mini.apps.assistant.validate_location
Valida o local onde criar o projeto de app.
reachy_mini.apps.assistant.validate_location_and_git_repo
Valida o local onde criar o projeto de app, garantindo que não esteja em um repositório git.
reachy_mini.apps.assistant.create_cli
Cria um novo projeto de app Reachy Mini usando uma CLI.
reachy_mini.apps.assistant.create
Cria um novo projeto de app Reachy Mini com o nome fornecido no caminho especificado.
Parâmetros:
| Nome | Tipo | Descrição |
|---|---|---|
console | Console | O objeto de console para imprimir mensagens. |
app_name | str | O nome do app a ser criado. |
app_path | Path | O diretório onde o projeto do app será criado. |
Retornos:
| Tipo | Descrição |
|---|---|
Path | O caminho para o projeto de app criado. |
reachy_mini.apps.assistant.install_app_with_progress
Instala o app em um ambiente virtual temporário com um indicador de progresso.
reachy_mini.apps.assistant.check
Verifica um projeto de app Reachy Mini existente.
Parâmetros:
| Nome | Tipo | Descrição |
|---|---|---|
console | Console | O objeto de console para imprimir mensagens. |
app_path | str | Caminho local para o app a ser verificado. |
reachy_mini.apps.assistant.request_app_addition
Solicita a adição do novo app à loja oficial de apps Reachy Mini.
reachy_mini.apps.assistant.try_to_push
Tenta enviar alterações para o repositório remoto.
reachy_mini.apps.assistant.publish
Publica o app na loja de apps Reachy Mini.
Parâmetros:
| Nome | Tipo | Descrição |
|---|---|---|
console | Console | O objeto de console para imprimir mensagens. |
app_path | str | Caminho local para o app a ser publicado. |
commit_message | str | Mensagem de commit para a publicação do app. |
official | bool | Solicitação para publicar o app como um app oficial Reachy Mini. |
no_check | bool | Não executar verificações antes de publicar o app. |
private | bool | None | Se True, tornar privado. Se False, tornar público. Se None, perguntar. |
Fontes de App
reachy_mini.apps.sources.hf_auth.save_hf_token
Salva com segurança um token de acesso HuggingFace.
Valida o token em relação à API do Hugging Face e, se for válido, o armazena usando o mecanismo padrão de autenticação do Hugging Face para reutilização entre sessões.
Parâmetros:
| Nome | Tipo | Descrição |
|---|---|---|
token | str | O token de acesso HuggingFace a ser salvo. |
Retornos:
| Tipo | Descrição |
|---|---|
dict | Um dicionário contendo: "status" ("success" ou "error"), "username" (o nome de usuário Hugging Face associado se bem-sucedido) e "message" (uma descrição do erro se malsucedido). |
reachy_mini.apps.sources.hf_auth.get_hf_token
Obtém o token HuggingFace armazenado.
Retornos:
| Tipo | Descrição |
|---|---|
str | None | O token armazenado ou None se nenhum token estiver armazenado. |
reachy_mini.apps.sources.hf_auth.delete_hf_token
Exclui tokens HuggingFace armazenados.
logout() sem argumentos desconecta de todos os tokens de acesso salvos.
reachy_mini.apps.sources.hf_auth.check_token_status
Verifica se um token está armazenado e é válido.
Retornos:
| Tipo | Descrição |
|---|---|
dict | Dicionário de status com is_logged_in e username. |
reachy_mini.apps.sources.hf_space.list_available_apps
Listar aplicativos disponíveis no Hugging Face Spaces.
reachy_mini.apps.sources.hf_space.list_all_apps
Listar todos os aplicativos disponíveis no Hugging Face Spaces (incluindo os não oficiais).
reachy_mini.apps.sources.local_common_venv.get_app_site_packages
API pública para obter o diretório site-packages do venv de um determinado aplicativo.
- Para venvs separados: retorna o
site-packagesdo venv do aplicativo - Para ambiente compartilhado (modo SDK): retorna o
site-packagesdo ambiente atual
reachy_mini.apps.sources.local_common_venv.get_app_python
Obter o caminho do executável Python para um aplicativo (multiplataforma).
- Para venvs separados: retorna o Python do venv do aplicativo
- Para ambiente compartilhado: retorna o interpretador Python atual
reachy_mini.apps.sources.local_common_venv.list_available_apps
Listar aplicativos disponíveis a partir de entry points ou venvs separados.
reachy_mini.apps.sources.local_common_venv.install_package
Instalar um pacote dado um objeto AppInfo, transmitindo os logs.
Parâmetros:
| Nome | Tipo | Descrição |
|---|---|---|
app | AppInfo | AppInfo com detalhes do pacote. |
logger | logging.Logger | Logger para saída de progresso. |
wireless_version | bool | Se está sendo executado na versão wireless. |
desktop_app_daemon | bool | Se está sendo executado como daemon de aplicativo desktop. |
force_reinstall | bool | Se True, força reinstalação mesmo que já esteja instalado (para atualizações). |
reachy_mini.apps.sources.local_common_venv.get_app_module
Obter o nome do módulo de um aplicativo sem carregá-lo (para execução em subprocesso).
reachy_mini.apps.sources.local_common_venv.uninstall_package
Desinstalar um pacote dado o nome de um aplicativo.
Utilitários de Aplicativo
reachy_mini.apps.utils.running_command
Executar um comando de shell e transmitir sua saída para o logger fornecido.