guligon90/main - Refactor project structure

[guligon90]

O que foi feito?

1. Criada uma nova estrutura de projeto:

SpeedTest
├── common
│   ├── __init__.py
│   └── settings.py
├── LICENSE
├── logger
│   ├── base.py
│   ├── __init__.py
│   ├── jobs.py
│   └── network.py
├── main.py
├── README.md
├── requirements-dev.txt
├── requirements.txt
└── test_results
    └── speed-data.xlsx

Nessa nova árvore, main.py agora é o script que executa a aquisição de velocidades de requisições, Em logger/base.py, foi implementada uma classe PeriodicThread, que encapsula as funcionalidades de threading.Timer e em logger/network.py, a classe NetworkSpeedLogger(PeriodicThread), que de fato executa periodicamente a aquisição e persistência de velocidades de requisição na planilha.

Em common/settings.py estão os parâmetros de configuração utilizados por outros módulos do sistema:

DOWNLOAD_SCALE_FACTOR = 10**-6
DOWNLOAD_SPEED_DECIMAL_PLACES = 2

LOG_DATE_FORMAT = '%d/%m/%Y'
LOG_TIME_FORMAT = '%H:%M:%S'

OUTPUT_FILE_PATH = 'test_results/speed-data.xlsx'
SAMPLING_INTERVAL = 5  # in seconds

2. Adicionado code linting ao projeto:

A consistência da base de código com as PEPs pode ser conferida agora utilizando o Prospector, cujo perfil está configurado no arquivo .prospector.yml.

3. Atualizada a documentação:

Vide README.md.

Como testar?

Basta seguir as instruções do README.md atualizado e verificar se tanto o teste de velocidade quanto o code linting estão funcionando como está sendo indicado na documentação.

[OctavioArruda]

Ficou bem legal essa nova estrutura com os parâmetros de configuração isolados.

[guligon90]

Olá @bguerbas, como vai?

Não sei se você está acompanhando as issues/PRs, mas eu submeti esse PR no início de abril. Se você ainda acha relevante a refatoração contida no mesmo, quando você tiver um tempo, seria interessante por parte sua uma revisão do código. Fico à disposição para discutirmos melhoramentos e/ou novas funcionalidades.

Muito obrigado!