Metadata-Version: 2.4
Name: brutils_py
Version: 0.1.0
Summary: Library for generation, validation and formatting of Brazilian data (CPF, CNPJ, RG, CEP, CNH, etc.)
Home-page: https://github.com/JGuylherme/brutils_py
Author: Guy
License: MIT
Classifier: Programming Language :: Python :: 3
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Classifier: Development Status :: 4 - Beta
Classifier: Intended Audience :: Developers
Classifier: Topic :: Software Development :: Libraries :: Python Modules
Requires-Python: >=3.12
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: requests
Provides-Extra: dev
Requires-Dist: pytest; extra == "dev"
Requires-Dist: pytest-mock; extra == "dev"
Requires-Dist: Faker; extra == "dev"
Dynamic: license-file

# brutils_py

**brutils_py** is a Python library for the generation, validation, and formatting of common Brazilian data used in documents, systems, and forms. It includes tools for working with CPF, CNPJ, RG, CNH, CEP, phone numbers, vehicle plates, and more.

It also offers integration with the [ViaCEP API](https://viacep.com.br) to verify the existence of a given CEP in real time.

---

## Features

- Generate and validate CPF (Cadastro de Pessoas Físicas)
- Generate and validate CNPJ (Cadastro Nacional da Pessoa Jurídica)
- Generate and validate RG (Registro Geral)
- Generate and validate CNH (Carteira Nacional de Habilitação)
- Generate, validate, and format CEP (Código de Endereçamento Postal)
- Check existence of CEP via ViaCEP API
- Generate and validate Título de Eleitor
- Generate and validate PIS and NIS numbers
- Generate and validate Brazilian phone numbers (mobile and landline)
- Generate and validate vehicle license plates (Mercosul and legacy formats)

---

## Installation

Install the library via pip:

```bash
pip install brutils_py
```

Note: This package requires Python 3.12 or higher.

## Development
To run tests locally, install the development dependencies:

```bash
pip install -e .[dev]
pytest
```

## License
This project is licensed under the MIT License. See LICENSE for more information.
