brutils-python
brutils-python copied to clipboard
feat: renavam add is_valid_renavam function with validation, tests, and docs
Descrição
Este Pull Request adiciona suporte à validação de números de RENAVAM no pacote brutils.
A função is_valid_renavam verifica se o dÃgito de verificação do RENAVAM corresponde aos 10 dÃgitos iniciais,
garantindo que o número fornecido seja válido do ponto de vista do algoritmo, sem consultar bases externas.
Mudanças Propostas
- Implementada a função
is_valid_renavampara validar RENAVAMs. - Criados testes unitários para casos válidos e inválidos, incluindo exceções.
- Adicionada documentação no README seguindo o padrão existente do projeto.
Checklist de Revisão
- [x] Eu li o Contributing.md
- [x] Os testes foram adicionados ou atualizados para refletir as mudanças (se aplicável).
- [x] Foi adicionada uma entrada no changelog / Meu PR não necessita de uma nova entrada no changelog.
- [x] A documentação em português foi atualizada ou criada, se necessário.
- [x] Se feita a documentação, a atualização do arquivo em inglês.
- [x] Eu documentei as minhas mudanças no código, adicionando docstrings e comentários. Instruções
- [x] O código segue as diretrizes de estilo e padrões de codificação do projeto.
- [x] Todos os testes passam. Instruções
- [x] O Pull Request foi testado localmente. Instruções
- [x] Não há conflitos de mesclagem.
Comentários Adicionais (opcional)
Issue Relacionada
Closes #430