Implementar uma aplicação Dash a partir do PlaidCloud Git

Este é o percurso completo desde o código da aplicação Dash na sua máquina até um URL em direto, usando o PlaidCloud Git — o serviço Git gerido incorporado na sua área de trabalho — como origem. Como o PlaidCloud Git é gerido, a ligação a partir da qual a aplicação é implementada não precisa de URL do servidor, nome de utilizador nem token: o PlaidCloud autentica-se em seu nome.

Existem cinco passos:

Escrever uma aplicação Dash mínima.
Colocá-la num repositório PlaidCloud Git.
Criar uma ligação gerida ao PlaidCloud Git.
Publicar uma aplicação Dash que aponte para o repositório.
Abrir a aplicação disponibilizada — e ler os registos de compilação se não arrancar.

Este guia é quase idêntico a Implementar uma aplicação Panel a partir do PlaidCloud Git — ambas são aplicações Python do lado do servidor, criadas a partir do Git e disponibilizadas da mesma forma. A diferença está no próprio código da aplicação e num campo da caixa de diálogo de publicação.

Antes de começar

Abra Git a partir da sua área de trabalho para confirmar que consegue aceder ao PlaidCloud Git. Por predefinição, a organização da sua área de trabalho inclui um repositório apps — a casa natural das aplicações Dash também.
Tenha o git instalado localmente se pretender enviar código a partir da sua máquina (também pode adicionar ficheiros na interface web do Git).

1. Escrever uma aplicação Dash mínima

A aplicação precisa de um ponto de entrada — um ficheiro Python que cria uma aplicação Dash e expõe o respetivo servidor Flask — e, opcionalmente, de um requirements.txt para pacotes adicionais, na raiz do repositório ou junto do ponto de entrada.

apps/
├── app.py            # entry point — exposes `server`
└── requirements.txt  # optional; extra dependencies (repo root or next to app.py)

Crie app.py:

import plaidcloud_dash as pcd
from dash import Dash, Input, Output, html

app = Dash(__name__)  # picks up DASH_URL_BASE_PATHNAME from the platform automatically
server = app.server   # the platform imports this and wires per-user sign-in for you

app.layout = html.Div(
    [
        html.H1("Hello from PlaidCloud Git"),
        html.P(id="whoami"),
        html.Button("Who am I?", id="whoami-btn", n_clicks=0),
    ]
)


@app.callback(Output("whoami", "children"), Input("whoami-btn", "n_clicks"))
def _whoami(n_clicks):
    if not n_clicks:
        return ""
    return f"Signed in as {pcd.current_user()!r}"


if __name__ == "__main__":
    app.run(debug=True)

Esta é uma aplicação completa. O dash, o plotly, o dash-mantine-components, o dash-ag-grid e as bibliotecas cliente do PlaidCloud (plaidcloud-rpc, plaidcloud-utilities) já vêm pré-instalados, pelo que deve listar no requirements.txt apenas os pacotes adicionais. Não passe requests_pathname_prefix nem url_base_pathname a Dash(__name__) — a plataforma define o prefixo do URL automaticamente através de DASH_URL_BASE_PATHNAME, e definir ambos gera um erro de configuração no arranque. Para o contrato completo da aplicação e os auxiliares de acesso a dados, consulte o contrato da aplicação e Ler dados e o utilizador com sessão iniciada numa aplicação Dash.

2. Colocar a aplicação num repositório PlaidCloud Git

Use o repositório apps já existente na sua área de trabalho ou crie um novo. Depois, coloque o código lá dentro.

Como inicia sessão através do PlaidCloud, a sua conta Git não tem uma palavra-passe separada — gere um token de acesso pessoal (o seu avatar → Settings → Applications) com âmbitos de Leitura e Escrita do repositório e use-o como palavra-passe quando o Git o pedir. Copie o URL de clonagem HTTPS do repositório a partir do botão Código e, em seguida:

git clone https://<your-git-host>/<org>/apps.git
cd apps
# add app.py (and requirements.txt), then:
git add app.py requirements.txt
git commit -m "Add hello dash app"
git push

Tome nota do caminho do repositório — <org>/apps — em que <org> é o nome da organização da sua área de trabalho. Irá introduzir esse caminho no passo seguinte. Os detalhes completos de clonagem, confirmação e envio encontram-se em Repositórios.

O token aqui serve apenas para si enviar código. A ligação que vai criar a seguir é gerida e não precisa de token — não confunda as duas coisas.

3. Criar uma ligação gerida ao PlaidCloud Git

Uma ligação indica a uma implementação Dash onde o respetivo código se encontra. No PlaidCloud Git, a ligação é gerida — o PlaidCloud fornece o anfitrião e as credenciais, pelo que só introduz o destino do repositório. É o mesmo tipo de ligação que uma aplicação Panel de servidor usa.

Abra Tools > Connections, clique em Nova ligação e escolha PlaidCloud Git.
Atribua à ligação um Nome da conta (por exemplo, Apps Repo).
Defina Repository Path como <org>/apps — o caminho que anotou no passo 2 — e Ramo predefinido como main. Deixe Caminho inicial em branco, a menos que as suas aplicações estejam num subdiretório.
Clique em Criar.

Não existe nenhum campo URL do servidor, Utilizador, Palavra-passe nem SSL/SSH — o PlaidCloud Git é gerido, pelo que a plataforma trata do anfitrião e da autenticação. Para o formulário completo, incluindo a Utilização e o Modelo de segurança da ligação (quem na área de trabalho a pode usar), consulte Ligação PlaidCloud Git.

4. Publicar a aplicação Dash

Agora, aponte uma implementação Dash para essa ligação.

Abra As minhas aplicações Panel e clique em Nova aplicação Dash.
Em Definições do diretório, defina um Nome da aplicação e um Slug de URL — o slug é o URL e o nome interno da aplicação, pelo que deve usar letras minúsculas, dígitos e hífenes, começar por uma letra e ter 40 carateres ou menos (por exemplo, hello-dash). Um Memorando opcional descreve a aplicação.
Em Ligação Git e monitor de publicação:
- Ligação Git — a ligação ao PlaidCloud Git que criou no passo 3.
- Filial — main. Os envios para este ramo recompilam e voltam a implementar a aplicação automaticamente.
- Ponto de entrada — app.py.
Em Tempo de execução, escolha o CPU, a Memória e a janela de Inatividade (minutos). Assinale Permitir acesso público apenas se a aplicação deve ser acessível sem iniciar sessão. Não existe a definição Design — é uma opção específica do Panel.
Em Avançado (disponibilização incorporada) — opcional. Deixe vazio, a menos que esteja a incorporar a aplicação noutro site.
Clique em Publicar.

5. Abrir a aplicação — e ler os registos se não arrancar

Depois de publicar, a aplicação é compilada: o PlaidCloud clona o ramo, instala o seu requirements.txt e cria uma imagem de contentor a partir da imagem platform-dash-base. O respetivo Estado é apresentado na lista As minhas aplicações Panel e é atualizado automaticamente.

Quando o Estado for Pronta, abra a aplicação em https://<your-tenant-host>/serve/<slug>/. O primeiro pedido depois de um período de inatividade volta a iniciá-la, mostrando um breve ecrã de carregamento do PlaidCloud enquanto o faz.
Se a compilação falhar, abra a aplicação e consulte os registos de Compilação — uma dependência em falta ou um erro de importação aparecem aí. Consulte Utilizar uma aplicação Dash para saber o que significa cada estado, como ler os registos e como acionar uma recompilação.

A partir daqui, cada envio para o ramo da ligação recompila e volta a implementar a aplicação automaticamente — edite o app.py, faça git push e a alteração entra em produção. (A menos que a aplicação esteja bloqueada, caso em que os envios são ignorados até a desbloquear — consulte Utilizar uma aplicação Dash.)

Passos seguintes

Ler dados e o utilizador com sessão iniciada numa aplicação Dash — consulte dados do PlaidCloud como a pessoa que está a ver a aplicação.
Utilizar uma aplicação Dash — estado da compilação, registos, bloqueio e remoção da aplicação.
Ligação PlaidCloud Git — o formulário completo da ligação, utilização e modelo de segurança.
Repositórios — ramos, tokens e colaboração no PlaidCloud Git.