Release Notes 2.0
Lançamento em 16 de julho de 2023.
Descrição
Este documento tem como objetivo organizar os novos documentos, funcionalidades e atualizações implementadas desde a primeira entrega do produto. Para mais informações acesse o ReadMe do repositório.
Funcionalidades implementadas
- Automatização da biblioteca: #24
- Geração de gráfico, wordcloud e tabela no relatório: #26 #42
- Relatório padronizado a partir da API do github: #35
- Tratamentos de erros: #25 #28 #37 #38
- Disponibilidade em diferentes sistemas operacionais: #31
- Upload no Pypi: #34 #43
Outras implementações
- Testes unitários: #32
- Pipeline de integração contínua: #30
- Organização do código: #40 #44
- Atualização Github pages: #27
- Atualização de documentos: #41
- UML da biblioteca: #22
Novos documentos
Observações release 2.0
Status code
- O uso da API pode gerar certas limitações tais como:
- Necessidade de conexão com a internet;
- Status Code 403: Dependendo do repositório e das quantidades de informações coletadas pela API do Github, o número de requisições pode vir a gerar um status_code 403, fazendo com que o usuário só possa voltar a fazer requisições posteriormente. A biblioteca ‘pyanalyticsgit’ conta com a função para exibir quando o usuário poderá voltar a fazer requisições.
Automação
- O usuário deve executar o arquivo a partir do diretório do Repositório no terminal (o diretório deve possuir o arquivo .git para a correta configuração).
- É necessário pois o método buscará o diretório hooks dentro do arquivo .git e adicionará o arquivo post-commit.
Internet
- Se houver conexão fraca de internet pode ocorrer erro 404 pois não foi possível obter todas as informações da API.