Home
====

Python library specific brazilian objects and validations.

.. image:: https://img.shields.io/badge/GitHub-Repository-blue?logo=github
   :target: https://github.com/abrasileirado/python_abrasileirado
   :alt: GitHub Repository

.. image:: https://img.shields.io/badge/License-MIT-lemon.svg
   :target: https://opensource.org/licenses/MIT
   :alt: License

.. image:: https://img.shields.io/pypi/pyversions/abrasileirado.svg
   :target: https://pypi.org/project/abrasileirado/
   :alt: Python

.. image:: https://github.com/abrasileirado/python_abrasileirado/actions/workflows/qa.yml/badge.svg
   :target: https://github.com/abrasileirado/python_abrasileirado/actions/workflows/qa.yml
   :alt: QA

.. image:: https://codecov.io/gh/abrasileirado/python_abrasileirado/branch/main/graph/badge.svg
   :target: https://codecov.io/gh/abrasileirado/python_abrasileirado
   :alt: Coverage

.. image:: https://github.com/abrasileirado/python_abrasileirado/actions/workflows/publish.yml/badge.svg
   :target: https://github.com/abrasileirado/python_abrasileirado/actions/workflows/publish.yml
   :alt: Publish

.. image:: https://github.com/abrasileirado/python_abrasileirado/actions/workflows/docs.yml/badge.svg
   :target: https://abrasileirado.github.io/python_abrasileirado/
   :alt: Docs

.. image:: https://img.shields.io/badge/pre--commit-enabled-brightgreen?logo=pre-commit
   :target: https://github.com/pre-commit/pre-commit
   :alt: pre-commit


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

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


Compare with others packages
----------------------------

There are several Python packages for Brazilian data validation and utilities.
Here’s how **abrasileirado** compares to some popular alternatives:

.. list-table::
   :header-rows: 1
   :widths: 40 15 15 15 15

   * - Feature
     - abrasileirado
     - validate-docbr
     - pycpfcnpj
     - brutils
   * - Test coverage
     - 100%
     - Unknown
     - Unknown
     - 99%
   * - Python 3.10+
     - ✅
     - ✅
     - ✅
     - ✅
   * - Immutable typed objects
     - ✅
     - 🚫
     - 🚫
     - 🚫
   * - CPF validation
     - ✅
     - ✅
     - ✅
     - ✅
   * - CNPJ validation
     - ✅
     - ✅
     - ✅
     - ✅
   * - CNH validation
     - ✅
     - ✅
     - 🚫
     - ✅
   * - CNS validation
     - ✅
     - ✅
     - 🚫
     - ✅
   * - CNES validation
     - ✅
     - ✅
     - 🚫
     - ✅
   * - PIS validation
     - ✅
     - ✅
     - 🚫
     - ✅
   * - RENAVAM validation
     - ✅
     - ✅
     - 🚫
     - ✅
   * - Titulo eleitoral validation
     - ✅
     - ✅
     - 🚫
     - ✅
   * - NUP validation
     - ✅
     - 🚫
     - 🚫
     - 🚫
   * - Telefone validation
     - ✅
     - 🚫
     - 🚫
     - 🚫
   * - Passaporte validation
     - ✅
     - 🚫
     - 🚫
     - 🚫
   * - Placa veicular validation
     - ✅
     - 🚫
     - 🚫
     - 🚫
   * - Certidão validation
     - 🚫
     - ✅
     - 🚫
     - 🚫
   * - Sim/Não enum
     - ✅
     - 🚫
     - 🚫
     - 🚫
   * - Estado civil enum
     - ✅
     - 🚫
     - 🚫
     - 🚫
   * - Cor/raça enum
     - ✅
     - 🚫
     - 🚫
     - 🚫
   * - Sexo enum
     - ✅
     - 🚫
     - 🚫
     - 🚫
   * - Gênero enum
     - ✅
     - 🚫
     - 🚫
     - 🚫
   * - Deficiência enum
     - ✅
     - 🚫
     - 🚫
     - 🚫
   * - Zona de habitação enum
     - ✅
     - 🚫
     - 🚫
     - 🚫
   * - Região geopolítica enum
     - ✅
     - 🚫
     - 🚫
     - 🚫
   * - Unidade federativa enum
     - ✅
     - 🚫
     - 🚫
     - 🚫
   * - Grupo de natureza jurídica enum
     - ✅
     - 🚫
     - 🚫
     - 🚫
   * - Natureza jurídica enum
     - ✅
     - 🚫
     - 🚫
     - 🚫

**abrasileirado** focuses on typed objects, enums, and validations for Brazilian-specific data, while
others are more focused on document validation only.

Installation
------------

.. code-block:: bash
   pip install abrasileirado

Requires Python 3.10+.

Quick example
-------------

To do

.. toctree::
   :maxdepth: 1

   getting-started
   contribute
   abrasileirado