Metadata-Version: 2.4
Name: brazilian
Version: 1.1.1
Summary: A complete library about faking / validating brazilian common data
Author-email: Maurício Reisdoefer Pereira <mauricio.reisdoefer2009@gmail.com>
License:                           MIT License
        
                            Copyright (c) 2025 Reisdoefer
        
        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/MauricioReisdoefer/brazilian
Project-URL: Documentation, https://github.com/MauricioReisdoefer/brazilian/tree/main/docs
Project-URL: Repository, https://github.com/MauricioReisdoefer/brazilian
Project-URL: Issues, https://github.com/MauricioReisdoefer/brazilian/issues
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: License :: OSI Approved :: GNU General Public License v3 (GPLv3)
Classifier: Operating System :: OS Independent
Requires-Python: >=3.9
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: requests
Provides-Extra: test
Requires-Dist: pytest; extra == "test"
Requires-Dist: pytest-cov; extra == "test"
Provides-Extra: pydantic
Requires-Dist: pydantic>=2.0; extra == "pydantic"
Provides-Extra: sqlalchemy
Requires-Dist: sqlalchemy>=2.0; extra == "sqlalchemy"
Provides-Extra: orm
Requires-Dist: pydantic>=2.0; extra == "orm"
Requires-Dist: sqlalchemy>=2.0; extra == "orm"
Provides-Extra: all
Requires-Dist: pytest; extra == "all"
Requires-Dist: pytest-cov; extra == "all"
Requires-Dist: pydantic>=2.0; extra == "all"
Requires-Dist: sqlalchemy>=2.0; extra == "all"
Dynamic: license-file

# Brazilian: Validação e Geração de Dados Brasileiros

**Brazilian** é uma biblioteca robusta para a manipulação, validação e geração de dados comuns no Brasil, como CPF, CRM, CNPJ e outros. Diferente de geradores simples, esta biblioteca oferece classes ricas em funcionalidades, permitindo formatação, mascaramento e extração de informações contextuais (como região de emissão).

## Instalação

Hoje, a versão mais recente é 1.1.1, e só depende do `requests` como biblioteca externa.

A versão 1.1.1 é a primeira versão estável. Versões anteriores **não terão retro-compatibilidade**.

```bash
pip install brazilian
```

## Uso Rápido

### 1. Classe CPF

A classe `CPF` permite validar, formatar e gerar números de Cadastro de Pessoas Físicas.

```python
from brazilian.documents import CPF

cpf = CPF("12345678900")

print(f"Valor limpo: {cpf.value}")        # Saída: 12345678900
print(f"Formatado: {cpf.formatted}")      # Saída: 123.456.789-00
print(f"Mascarado: {cpf.masked}")        # Saída: ***.***.***-00
print(f"É válido? {cpf.is_valid}")       # Saída: True/False
print(f"Região de emissão: {cpf.region}") # Saída: Sao Paulo

# Geração de CPF válido
novo_cpf = CPF.generate()
print(f"Novo CPF gerado: {novo_cpf.formatted}")
```

### 2. Classe CRM

A classe `CRM` permite validar, formatar e gerar números de Registro no Conselho Regional de Medicina.

```python
from brazilian.documents import CRM

# Validação e Formatação
crm = CRM("123456SP")

print(f"Valor limpo: {crm.value}")        # Saída: 123456SP
print(f"Formatado: {crm.formatted}")      # Saída: 123456-SP
print(f"Mascarado: {crm.masked}")        # Saída: ***456-SP
print(f"É válido? {crm.is_valid}")       # Saída: True/False
print(f"Estado (UF): {crm.uf}")          # Saída: Sao Paulo
print(f"Região: {crm.region}")           # Saída: Sudeste

# Geração de CRM válido para um UF específico
novo_crm = CRM.generate(uf="RJ")
print(f"Novo CRM gerado (RJ): {novo_crm.formatted}")
```

## Principais Funcionalidades

* **Validação Robusta:** Implementa a lógica de validação oficial para garantir a integridade dos dados.
* **Formatação Flexível:** Oferece métodos para formatar e mascarar os documentos (ex: `XXX.XXX.XXX-XX` ou `***.***.***-XX`).
* **Geração de Dados:** Métodos estáticos para gerar números válidos e aleatórios.
* **Informação Contextual:** Extração de dados como a região de emissão (CPF) ou o estado/região (CRM).

## Extras Opcionais

Você pode instalar dependências extras para funcionalidades adicionais:

* **Pydantic**: para usar os modelos do `brazilian.pydantic`  

    ```bash
    pip install brazilian[pydantic]
    ```

    Isso adiciona o pydantic como dependência e permite usar os modelos Pydantic para CPF, CNPJ etc.

* **Testes**: para rodar os testes da biblioteca

    ```bash
    pip install brazilian[test]
    ```

    Isso instala pytest para facilitar o desenvolvimento e a execução de testes.

* **SQLAlchemy**: para utilizar classes prontas do SQLAlchemy

    ```bash
    pip install brazilian[sqlalchemy]
    ```

    Isso instala módulos necessários para utilizar os SQLAlchemy Types

* **ORM**: Importação completa com suporte para ORM do SQLAlchemy

    ```bash
    pip install brazilian[orm]
    ```

    Instala direto o SQLAlchemy junto do Pydantic, onde são utilizados juntos dentro das classes internas.

## Documentação Completa

Para detalhes sobre todas as propriedades e métodos disponíveis, consulte a [Documentação Completa](/docs).

* [CPF](/docs/CPF.md)
* [CNPJ](/docs/CNPJ.md)
* [CEP](/docs/CEP.md)
* [CRM](/docs/CRM.md)
* [Date](/docs/Date.md/)

## Contribuição

Para contribuir, acesse:
[CONTRIBUTING.md](CONTRIBUTING.md)

---

[![PyPI version](https://badge.fury.io/py/brazilian.svg)](https://pypi.org/project/brazilian/0.4.1/)
[![GitHub Stars](https://img.shields.io/github/stars/MauricioReisdoefer/brazilian.svg?style=flat&label=Stars)](https://github.com/MauricioReisdoefer/brazilian/stargazers)
[![PyPI - Downloads](https://pepy.tech/badge/brazilian/month)](https://pepy.tech/project/brazilian)
[![codecov](https://codecov.io/github/MauricioReisdoefer/brazilian/graph/badge.svg?token=SD3T9KYZFR)](https://codecov.io/github/MauricioReisdoefer/brazilian)
