Utils library for specific Brazilian businesses
Project description
🇧🇷 Brazilian Utils
Utils library for Brazilian-specific businesses.
Looking for the english version?
Procurando a documentação da versão 1.0.1?
Introdução
Brazilian Utils é uma biblioteca com foco na resolução de problemas que enfrentamos diariamente no desenvolvimento de aplicações para o business Brasileiro.
Instalação
pip install brutils
Utilização
Para usar um de nossos utilitários, basta importar a função necessária, como no exemplo abaixo:
>>> from brutils import is_valid_cpf
>>> is_valid_cpf('00011122233')
False
Utilitários
CPF
is_valid_cpf
Verifica se o CPF é valido. Apenas números, formatados como string. Não verifica se o CPF existe.
>>> from brutils import is_valid_cpf
>>> is_valid_cpf('00011122233')
False
format_cpf
Formata o CPF. Retorna None se o CPF for inválido.
>>> from brutils import format_cpf
>>> format_cpf('11144477735')
'111.444.777-35'
remove_symbols_cpf
Remove os símbolos de formatação do CPF e retorna somente números. Filtra apenas os símbolos utilizados para a validação do CPF. Propositalmente não remove outros símbolos.
>>> from brutils import remove_symbols_cpf
>>> remove_symbols_cpf('000.111.222-33')
'00011122233'
generate_cpf
Gera um CPF válido aleatório.
>>> from brutils import generate_cpf
>>> generate_cpf()
'17433964657'
CNPJ
is_valid_cnpj
Verifica se o CNPJ é valido. Apenas números, formatados como string. Não verifica se o CNPJ existe.
>>> from brutils import is_valid_cnpj
>>> is_valid_cnpj('00111222000133')
False
format_cnpj
Formata o CNPJ.
>>> from brutils import format_cnpj
>>> format_cnpj('00111222000100')
'00.111.222/0001-00'
remove_symbols_cnpj
Remove os símbolos de formatação do CPF e retorna somente números. Filtra apenas os símbolos utilizados para a validação do CPF. Propositalmente não remove outros símbolos.
>>> from brutils import remove_symbols_cnpj
>>> remove_symbols_cnpj('00.111.222/0001-00')
'00111222000100'
generate_cnpj
Gera um CNPJ válido aleatório.
>>> from brutils import generate_cnpj
>>> generate_cnpj()
'34665388000161'
CEP
is_valid_cep
Verifica se o CEP é valido. Apenas números, formatados como string. Não verifica se o CEP existe.
>>> from brutils import is_valid_cep
>>> is_valid_cep('01310200')
True
format_cep
Formata o CEP. Retorna None se o CEP for inválido.
>>> from brutils import format_cep
>>> format_cep('01310200')
'01310-200'
remove_symbols_cep
Remove os símbolos de formatação do CEP e retorna somente números. Filtra apenas os símbolos utilizados para a validação do CEP. Propositalmente não remove outros símbolos.
>>> from brutils import remove_symbols_cep
>>> remove_symbols_cep('01310-200')
'01310200'
generate_cep
Gera um CEP válido aleatório.
>>> from brutils import generate_cep
>>> generate_cep()
'77520503'
Contributing
Sua colaboração é sempre bem-vinda! Preparamos o arquivo contributing pra te ajudar nos primeiros passos. Toda ajuda conta! Sinta-se livre para criar novas GitHub issues e interagir aqui.
Vamos construir juntos! 🚀🚀
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.