Metadata-Version: 2.4
Name: abrasileirado
Version: 1.0.1
Summary: Python library specific brazilian objects and validations.
Author-email: Kelson da Costa Medeiros <kelsoncm@gmail.com>
License: # The MIT License (MIT)
        
        Copyright (c) 2015 kelsoncm
        
        Permission is hereby granted, free of charge, to any person obtaining a copy
        of this software and associated documentation files (the "Software"), to deal
        in the Software without restriction, including without limitation the rights
        to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
        copies of the Software, and to permit persons to whom the Software is
        furnished to do so, subject to the following conditions:
        
        The above copyright notice and this permission notice shall be included in all
        copies or substantial portions of the Software.
        
        THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
        IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
        FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
        AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
        LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
        OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
        SOFTWARE.
        
Project-URL: Homepage, https://github.com/abrasileirado/python_abrasileirado
Project-URL: Issues, https://github.com/abrasileirado/python_abrasileirado/issues
Project-URL: Download, https://github.com/abrasileirado/python_abrasileirado/releases/
Project-URL: Docs, https://abrasileirado.github.io/python_abrasileirado/
Classifier: Development Status :: 5 - Production/Stable
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: 3.13
Classifier: Programming Language :: Python :: 3.14
Requires-Python: >=3.10
Description-Content-Type: text/markdown
License-File: LICENSE.md
Provides-Extra: dev
Requires-Dist: pre-commit>=4.6.0; extra == "dev"
Requires-Dist: black>=26.3.1; extra == "dev"
Requires-Dist: ruff>=0.15.11; extra == "dev"
Requires-Dist: doc8>=2.0.0; extra == "dev"
Requires-Dist: pytest>=9.0.3; extra == "dev"
Requires-Dist: pytest-cov>=7.1.0; extra == "dev"
Requires-Dist: python-dotenv>=1.2.2; extra == "dev"
Requires-Dist: pytest-coverage-gate>=1.0.3; extra == "dev"
Dynamic: license-file

# Python BRfied

![License](https://img.shields.io/badge/License-MIT-lemon.svg)
[![Python](https://img.shields.io/pypi/pyversions/abrasileirado.svg)](https://pypi.org/project/abrasileirado/)
[![QA](https://github.com/abrasileirado/python_abrasileirado/actions/workflows/qa.yml/badge.svg)](https://github.com/abrasileirado/python_abrasileirado/actions/workflows/qa.yml)
[![Coverage](https://codecov.io/gh/abrasileirado/python_abrasileirado/branch/main/graph/badge.svg)](https://codecov.io/gh/abrasileirado/python_abrasileirado)
[![Publish](https://github.com/abrasileirado/python_abrasileirado/actions/workflows/publish.yml/badge.svg)](https://github.com/abrasileirado/python_abrasileirado/actions/workflows/publish.yml)
[![Docs](https://github.com/abrasileirado/python_abrasileirado/actions/workflows/docs.yml/badge.svg)](https://abrasileirado.github.io/python_abrasileirado/)
[![pre-commit](https://img.shields.io/badge/pre--commit-enabled-brightgreen?logo=pre-commit)](https://github.com/pre-commit/pre-commit)

Python library specific brazilian objects and validations.

FAQ 1:
> Why I create abrasileirado? Because **this is Brazil** (Toretto, 2020).

FAQ 2:
> Why are classes, properties, and methods in Portuguese? (Toretto, 2020) already answered.

FAQ 3:
> Why not `validate-docbr`, `pycpfcnpj` or `brutils`?
> Because I prefer Immutable classes and here we have more types implementeds. See [comparation](https://abrasileirado.github.io/python_abrasileirado/index.html).

## Immutable classes

With validation, formating and unformating

* ✅ CEP - Código de Endereçamento Postal - Empresa de Correio e Telegráfos (ECT)
* ✅ EnderecoBrasil - ECT
* ✅ CPF - Cadastro de Pessoa Física - Receita Federal do Brasil (RFB)
* ✅ CNPJ (new and old standard) - Cadastro Nacional de Pessoa Jurídica - RFB
* ✅ CNES - Cadastro Nacional de Estabelecimento de Saúde - DATASUS
* ✅ CNS - Cadastro Nacional de Saúde (Cartão SUS) - DATASUS
* ✅ PIS - Programa de Integração Social - Tesouro Nacional
* ✅ RENAVAM - Registro Nacional de Veículos Automotores - Secretaria Nacional de Trânsito (Senatran)
* ✅ TituloEleitoral - Tribunal Superior Eleitoral - TSE
* ✅ Telefone - Agência Nacional de Telecomunicações (Anatel)
* ✅ Passaporte - Polícia Federal (PF)
* ✅ PlacaVeicular - Conselho Nacional de Trânsito (CONTRAN)
* ✅ NUP - Número Único de Processo - Conselho Nacional de Justiça (CNJ)
* ✅ CertidaoRCPN - Certidão de nascimento, casamento e outros - Conselho Nacional de Justiça (CNJ)

CEP, EnderecoBrasil, CPF, CNPJ, CNH, CNS, CNES, PIS, RENAVAM, Titulo
eleitoral, NUP, Telefone, Passaporte, Placa veicular, Certidão

## Enums

In accordance with regulatory bodies

* ✅ Sim/Não (Enum)
* ✅ Estado Civil (Enum) - Instituto Brasileiro de Geografia e Estatística (IBGE)
* ✅ Cor/Raça (Enum) - IBGE
* ✅ Sexo (Enum) - IBGE
* ✅ Gênero (Enum) - IBGE*
* ✅ Deficiência (Enum) - IBGE
* ✅ Zona de habitação (Enum) - IBGE
* ✅ Região geopolítica (Enum) - IBGE
* ✅ Unidade federativa (Enum) - IBGE
* ✅ Grupo de natureza jurídica (Enum) - IBGE
* ✅ Natureza jurídica (Enum) - IBGE

* 🚫 Modulo11
* 🚫 ProtocoloIntegrado
* 🚫 ProtocoloJustica
* 🚫 PJE
* 🚫 Boleto
* 🚫 NFE
* 🚫 Municipio

## Validações e formatações

* [x] validate_masked_value
* [x] validate_cpf
* [x] validate_cnpj
* [x] validate_mask
* [x] validate_mod11
* [x] validate_dv_by_mask
* [ ] CEP
* [ ] Data
* [ ] Hora
* [ ] Data e hora
* [ ] CNES
* [ ] CNS
* [ ] Protocolo integrado (<https://protocolointegrado.gov.br/Protocolo/projeto.jsf>)
* [ ] Protocolo justiça (<https://www.conjur.com.br/2009-jan-23/cnj-define-padrao-numeracao-processos-todos-tribunais>
      <http://www.stf.jus.br/portal/cms/verTexto.asp?servico=processoPeticaoEletronica&pagina=Informacoes_gerais_apos_desligamento_v1>)
* [ ] PJe
* [ ] Linha digitável de boleto
* [ ] Código de barra de boleto
* [ ] Linha digitável de título
* [ ] Código de barra de título
* [ ] Nota fiscal eletrônica
* [ ] Código de município do IBGE (<https://github.com/chinnonsantos/sql-paises-estados-cidades>
      <https://concla.ibge.gov.br/classificacoes/por-tema/codigo-de-areas/codigo-de-areas>)
* [ ]  is_only_digits
* [ ]  apply_mask
