Configurando um ambiente de desenvolvimento¶
A contribuição para BeeWare exige que você configure um ambiente de desenvolvimento.
Pré-requisitos¶
Você precisará instalar os seguintes pré-requisitos.
BeeWare requer Python 3.10+. Você também precisará
de um método para gerenciar ambientes virtuais (como o venv).
Para verificar a versão do Python que você instalou, execute:
$ python3 --version
Se você tiver mais de uma versão do Python instalada, talvez seja necessário
substituir python3 por um número de versão específico (por exemplo, python3.13)
Recomendamos evitar versões do Python lançadas recentemente (ou seja, versões que tenham um micro-número de versão ".0" ou ".1", como, por exemplo, 3.14.0). Isso ocorre porque as ferramentas necessárias para dar suporte ao Python no macOS geralmente ficam defasadas e não estão disponíveis para as versões estáveis do Python lançadas recentemente.
BeeWare requer Python 3.10+. Você também precisará
de um método para gerenciar ambientes virtuais (como o venv).
Para verificar a versão do Python que você instalou, execute:
$ python3 --version
Se você tiver mais de uma versão do Python instalada, talvez seja necessário
substituir python3 por um número de versão específico (por exemplo, python3.13)
Recomendamos evitar versões do Python lançadas recentemente (ou seja, versões que tenham um micro número de versão ".0" ou ".1", como, por exemplo, 3.14.0). Isso ocorre porque as ferramentas necessárias para dar suporte ao Python no Linux geralmente ficam defasadas e não estão disponíveis para as versões estáveis do Python lançadas recentemente.
BeeWare requer Python 3.10+. Você também precisará
de um método para gerenciar ambientes virtuais (como o venv).
Para verificar a versão do Python que você instalou, execute:
C:\...>py -3 --version
Se você tiver mais de uma versão do Python instalada, talvez seja necessário
substituir o -3 por um número de versão específico (por exemplo, -python3.13)
Recomendamos evitar versões do Python lançadas recentemente (ou seja, versões que tenham um micro número de versão ".0" ou ".1", como, por exemplo, 3.14.0). Isso ocorre porque as ferramentas necessárias para dar suporte ao Python no Windows geralmente ficam defasadas e não estão disponíveis para as versões estáveis do Python lançadas recentemente.
Configure seu ambiente de desenvolvimento¶
A maneira recomendada de configurar seu ambiente de desenvolvimento para BeeWare é usar um ambiente virtual e, em seguida, instalar a versão de desenvolvimento de BeeWare e suas dependências.
Clonar o repositório BeeWare¶
Em seguida, vá para a página BeeWare no GitHub e, se ainda não o fez, bifurque o repositório em sua própria conta. Em seguida, clique no botão "<> Code" em sua bifurcação. Se você tiver o aplicativo de desktop GitHub instalado no seu computador, poderá selecionar "Open with GitHub Desktop"; caso contrário, copie a URL HTTPS fornecida e use-a para clonar o repositório no seu computador usando a linha de comando:
Faça um fork do repositório BeeWare e, em seguida:
$ git clone https://github.com/<your username>/beeware.git
(substituindo seu nome de usuário do GitHub)
Faça um fork do repositório BeeWare e, em seguida:
$ git clone https://github.com/<your username>/beeware.git
(substituindo seu nome de usuário do GitHub)
Faça um fork do repositório BeeWare e, em seguida:
C:\...>git clone https://github.com/<your username>/beeware.git
(substituindo seu nome de usuário do GitHub)
Definir um repositório upstream¶
Após clonar seu fork, adicione o repositório BeeWare como um upstream remoto.
Isso fornece ao seu clone local uma referência ao repositório original,
facilitando a sincronização de atualizações ao longo do tempo.
Você também precisará de tags de upstream para que ferramentas como Toga e
Briefcase possam resolver números de versão precisos:
$ git remote add upstream https://github.com/beeware/beeware.git
$ git fetch --tags upstream
$ git remote add upstream https://github.com/beeware/beeware.git
$ git fetch --tags upstream
C:\...>git remote add upstream https://github.com/beeware/beeware.git
C:\...>git fetch --tags upstream
Se você quiser que seu fork também inclua essas tags, você pode enviá-las:
$ git push --tags
Isso pode ser útil se você criar um novo clone posteriormente e quiser que as tags estejam disponíveis em seu fork.
Criar um ambiente virtual¶
Para configurar um ambiente virtual e atualizar o pip, execute:
$ cd beeware
$ python3 -m venv .venv
$ source .venv/bin/activate
(.venv) $ python -m pip install -U pip
$ cd beeware
$ python3 -m venv .venv
$ source .venv/bin/activate
(.venv) $ python -m pip install -U pip
C:\...>cd beeware
C:\...>py -3 -m venv .venv
C:\...>.venv\Scripts\activate
(.venv) $ python -m pip install -U pip
Seu prompt agora deve ter um prefixo (.venv) na frente.
Instalar BeeWare¶
Agora que você tem o código-fonte, pode fazer uma instalação editável de BeeWare em seu ambiente de desenvolvimento. Execute o seguinte comando:
(.venv) $ python -m pip install -U -e . --group dev
(.venv) $ python -m pip install -U -e . --group dev
(.venv) C:\...>python -m pip install -U -e . --group dev
Ativar o pré-compromisso¶
BeeWare usa uma ferramenta chamada pre-commit para identificar problemas simples e padronizar a formatação do código. Ele faz isso instalando um gancho do git que executa automaticamente uma série de linters de código antes de finalizar qualquer commit do git. Para ativar o pre-commit, execute:
(.venv) $ pre-commit install
pre-commit installed at .git/hooks/pre-commit
(.venv) $ pre-commit install
pre-commit installed at .git/hooks/pre-commit
(.venv) C:\...>pre-commit install
pre-commit installed at .git/hooks/pre-commit
Agora você está pronto para começar a hackear o BeeWare!