Metadata-Version: 2.1
Name: simple-cpf
Version: 0.1.4
Summary: A simple script to manipulate and validate CPF
Author: czargodoi
Author-email: czargodoi@gmail.com
Requires-Python: >=3.10,<4.0
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Description-Content-Type: text/markdown

# Simple CPF

A simple package to validate and format the CPF - _Brazil Identification Card_.   

## Installation

```bash
pip install simple-cpf
```

## How to use

```python
import simple_cpf.simple_cpf import CPF

# validating a cpf
CPF.is_valid('117.762.459-11')  # True
CPF.is_valid('117.762.459-19')  # False

# generating a fake cpf
CPF.fake()                      # '917.350.558-75'

# formatting a valid cpf
CPF.formatted('10757246354')    # '107.572.463-54'
                                # in case of invalid cpf, it will return:
                                # 'Enter a valid CPF.'
```

## Made by:
cesargodoi  -  https://github.com/cesargodoi/simple_cpf
