Setup

Recomendado instalar o Pyenv, para gerenciar as versões do python. Para instalar a versão 3.8.10 necessária para o projeto, basta rodar o comando pyenv install 3.8.10 no terminal. Instalar o Face Recognition (instalar depois de ativar o ambiente virtual)

Temos duas opções para configurar o ambiente:

• Rodando os comandos um por vez

# Instala a biblioteca de ambiente virtual
access-control-project> python -m pip install virtualenv
# Cria o ambiente virtual
access-control-project> virtualenv .venv
# Ativa o ambiente virtual
access-control-project> .venv\Scripts\activate
# Instala o pip-tools
(.venv) access-control-project> python -m pip install pip-tools

# Windows
# Gera o requirements.txt
(.venv) access-control-project> pip-compile --upgrade --resolver=backtracking
# Instala as dependências
(.venv) access-control-project> pip-sync

# Linux (Não testado)
# Gera o requirements.txt
(.venv) access-control-project> pip-compile requirements_linux.in --upgrade --resolver=backtracking
# Instala as dependências
(.venv) access-control-project> pip-sync requirements_linux.txt

Tudo junto, para facilitar:

# Windows CMD e Powershell
> python -m pip install virtualenv & virtualenv .venv & .venv\Scripts\activate & python -m pip install pip-tools & pip-compile --upgrade --resolver=backtracking & pip-sync
> python -m pip install virtualenv ; virtualenv .venv ; .venv\Scripts\activate ; python -m pip install pip-tools ; pip-compile --upgrade --resolver=backtracking ; pip-sync

# Linux (Não testado)
> python -m pip install virtualenv ; virtualenv .venv ; .venv\Scripts\activate ; python -m pip install pip-tools ; pip-compile requirements_linux.in --upgrade --resolver=backtracking ; pip-sync requirements_linux.txt

• Rodando o script start.bat com a opção Setup do ambiente

---

Requirements

Temos duas opções para instalar as dependências:

• Rodando os comandos um por vez

# Ativa o ambiente virtual
access-control-project> .venv\Scripts\activate

# Windows
# Gera o requirements.txt
(.venv) access-control-project> pip-compile --upgrade --resolver=backtracking
# Instala as dependências
(.venv) access-control-project> pip-sync

# Linux (Não testado)
# Gera o requirements.txt
(.venv) access-control-project> pip-compile requirements_linux.in --upgrade --resolver=backtracking
# Instala as dependências
(.venv) access-control-project> pip-sync requirements_linux.txt

Tudo junto, para facilitar:

# Windows CMD e Powershell
> .venv\Scripts\activate & pip-compile --upgrade --resolver=backtracking & pip-sync
> .venv\Scripts\activate ; pip-compile --upgrade --resolver=backtracking ; pip-sync

# Linux (Não testado)
> .venv\Scripts\activate ; pip-compile requirements_linux.in --upgrade --resolver=backtracking ; pip-sync requirements_linux.txt

• Rodando o script helper.bat com a opção Atualizar dependencias

---

Observações

Para desativar o ambiente virtual, rodar o comando deactivate.

(.venv) access-control-project>            # Ativo
(.venv) access-control-project> deactivate # Comando de desativar
access-control-project>                    # Não ativo

Outro ponto importante é verificar se o ambiente virtual está ativo antes de rodar os comandos de requerimento, caso não esteja, ele vai desinstalar/atualizar as dependências do seu ambiente global, o que pode causar problemas.

Verificações pre-commit

Conseguimos verificar se o código está seguindo os padrões de código com o pre-commit. Ele é um framework que executa scripts antes de cada commit, e se algum deles falhar, o commit não é realizado.
Para instalar o pre-commit, basta rodar o comando pre-commit install no terminal (dentro do ambiente virtual).
Para rodar o pre-commit manualmente, basta rodar o comando pre-commit run --all-files no terminal.

Testes

Para rodar os testes, basta rodar o comando pytest no terminal.

Problemas conhecidos

Atualmente não roda em sistemas operacionais Linux.