MRs com todas as contribuições da sprint de refatoração

closes #86 (closed), #87 (closed)

Esse MRs uniu todos os MRs de refatoração feitos nesse repositório durante a sprint de refatoração.

!83 (closed) Add docstrings and typing

Melhora o módulo models.py do pacote transductor_model.

Nesse MR foi:

• removido imports não utilizados neste módulo.
• Adicionado docstrings nos métodos não triviais
• Modificado o script de teste do CI
  • Invés de utilizar explicitamente o pytest, é utilizado o manage.py do django (python manage.py test)
    • Essa modificação permite que o django defina qual versão do pytest será utilizada, facilitando futuras migrações para versões posteriores do django.
    • Foi definido o grau 3 de verbosity, para assim facilitar a visualização de quais módulos possuem testes quebrados.

!82 (closed) Remove imports não utilizados e aplica linter isort

Nesse MR foi:

• removido imports não utilizados de todos os módulos do repositório
• Foi separado o INSTALLED_APPS em 3 listas (DJANGO_APPS, EXTERNAL_APPS, LOCAL_APPS)
• Foi aplicado o linter isort para padronizar a ordem de imports de todos os módulos do projeto
• Foi comentado o cronjob CorrectDateCronJob, pois não estava definido.
  • A rotina desse cronjob não está definida em nenhum local da base de código

!81 (closed) Resolve "Remover do requirements.txt as bibliotecas que são usadas indiretamente"

Nesse MR foi:

• modificado o arquivo requirements.txt para listar somente as bibliotecas explicitamente utilizadas, ou seja, foi removido todas as depedências indiretas. (para mais detalhes leia o texto do MRs !81 (closed))
• Foi modificado o arquivo tox.ini para excluir da rotina de checagem de folha de estilos os arquivos de migração, o módulo settings.py, e os repositórios de virtualenv (/env e /venv)

!80 (closed) Refatora o método set_broken e adiciona suite de teste para o método set_broken

Nesse MR foi:

• refatorado o método set_broken do módulo transductor/models.py.
  • A lógica de mudança de estado permanece a mesma, porém com codificação mais simples e comentários.
  • Foi adicionado typing (definição dos tipos de dados que estão sendo recebidos e enviados)