Skip to content

Commit

Permalink
Atualizando README (#87)
Browse files Browse the repository at this point in the history
  • Loading branch information
@antoniamaia
antoniamaia committed May 13, 2023
1 parent 3bbdbe4 commit f2ef2ef
Show file tree
Hide file tree
Showing 2 changed files with 39 additions and 39 deletions.
39 changes: 18 additions & 21 deletions README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -3,40 +3,40 @@

<p>Utils library for Brazilian-specific businesses.</p>


[![codecov](https://codecov.io/gh/brazilian-utils/brutils-python/branch/main/graph/badge.svg?token=5KNECS8JYF)](https://codecov.io/gh/brazilian-utils/brutils-python)
[![Downloads per Month](https://shields.io/pypi/dm/brutils)](https://pypi.org/project/brutils/)
[![Package version](https://shields.io/pypi/v/brutils)](https://pypi.org/project/brutils/)
### [Procurando pela versão em português?](README_PT_BR.md)
### [Looking for 1.0.1 version documentation?](/documentation%20v1.0.1/ENGLISH_VERSION.md)

### [Looking for the english version?](README_EN.md)
### [Procurando a documentação da versão 1.0.1?](/documentation%20v1.0.1/PORTUGUESE_VERSION.md)
</div>

# Getting Started
# Introdução

Brazilian Utils is a library focused on solving problems that we face daily in
the development of applications for the Brazilian business.
Brazilian Utils é uma biblioteca com foco na resolução de problemas que enfrentamos diariamente no desenvolvimento de aplicações para o business Brasileiro.

## Installation
## Instalação

```
pip install brutils
```

## Usage
## Utilização

To use one of our utilities you just need to import the required function as in the example below:
Para usar um de nossos utilitários, basta importar a função necessária, como no exemplo abaixo:

```python
>>> from brutils import is_valid_cpf
>>> is_valid_cpf('00011122233')
False
```

# Utilities
# Utilitários

## is_valid_cpf

Check if CPF is valid. Numbers only, formatted as strings.
Verifica se o CPF é valido.

```python
>>> from brutils import is_valid_cpf
Expand All @@ -46,7 +46,7 @@ False

## format_cpf

Format CPF.
Formata o CPF.

```python
>>> from brutils import format_cpf
Expand All @@ -56,9 +56,8 @@ Format CPF.

## parse_cpf

Remove formatting symbols from CPF and return only digits.
It only filters out the symbols used for CPF validation.
It purposefully doesn't remove other symbols.
Remove os símbolos de formatação do CPF e retorna somente números. Filtra apenas os símbolos utilizados para a validação do CPF. Propositalmente não remove outros símbolos.


```python
>>> from brutils import parse_cpf
Expand All @@ -67,7 +66,7 @@ It purposefully doesn't remove other symbols.
```
## generate_cpf

Generate a valid random CPF.
Gera um CPF válido aleatório.

```python
>>> from brutils import generate_cpf
Expand All @@ -77,7 +76,7 @@ Generate a valid random CPF.

## is_valid_cnpj

Check if CNPJ is valid. Numbers only, formatted as strings.
Verifica se o CNPJ é valido. Apenas números, formatados como string.

```python
>>> from brutils import is_valid_cnpj
Expand All @@ -87,7 +86,7 @@ False

## format_cnpj

Format CNPJ.
Formata o CNPJ.

```python
>>> from brutils import format_cnpj
Expand All @@ -97,9 +96,7 @@ Format CNPJ.

## parse_cnpj

Remove formatting symbols from CNPJ and return only digits.
It only filters out the symbols used for CNPJ validation.
It purposefully doesn't remove other symbols.
Remove os símbolos de formatação do CPF e retorna somente números. Filtra apenas os símbolos utilizados para a validação do CPF. Propositalmente não remove outros símbolos.

```python
>>> from brutils import parse_cnpj
Expand All @@ -109,7 +106,7 @@ It purposefully doesn't remove other symbols.

## generate_cnpj

Generate a valid random CNPJ.
Gera um CNPJ válido aleatório.

```python
>>> from brutils import generate_cnpj
Expand Down
39 changes: 21 additions & 18 deletions README_PT_BR.md → README_EN.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -3,40 +3,40 @@

<p>Utils library for Brazilian-specific businesses.</p>


[![codecov](https://codecov.io/gh/brazilian-utils/brutils-python/branch/main/graph/badge.svg?token=5KNECS8JYF)](https://codecov.io/gh/brazilian-utils/brutils-python)
[![Downloads per Month](https://shields.io/pypi/dm/brutils)](https://pypi.org/project/brutils/)
[![Package version](https://shields.io/pypi/v/brutils)](https://pypi.org/project/brutils/)
### [Procurando pela versão em português?](README.md)
### [Looking for 1.0.1 version documentation?](/documentation%20v1.0.1/ENGLISH_VERSION.md)

### [Looking for the english version?](README.md)
### [Procurando a documentação da versão 1.0.1?](/documentation%20v1.0.1/PORTUGUESE_VERSION.md)
</div>

# Introdução
# Getting Started

Brazilian Utils é uma biblioteca com foco na resolução de problemas que enfrentamos diariamente no desenvolvimento de aplicações para o business Brasileiro.
Brazilian Utils is a library focused on solving problems that we face daily in
the development of applications for the Brazilian business.

## Instalação
## Installation

```
pip install brutils
```

## Utilização
## Usage

Para usar um de nossos utilitários, basta importar a função necessária, como no exemplo abaixo:
To use one of our utilities you just need to import the required function as in the example below:

```python
>>> from brutils import is_valid_cpf
>>> is_valid_cpf('00011122233')
False
```

# Utilitários
# Utilities

## is_valid_cpf

Verifica se o CPF é valido. Apenas números, formatados como string.
Check if CPF is valid.

```python
>>> from brutils import is_valid_cpf
Expand All @@ -46,7 +46,7 @@ False

## format_cpf

Formata o CPF.
Format CPF.

```python
>>> from brutils import format_cpf
Expand All @@ -56,8 +56,9 @@ Formata o CPF.

## parse_cpf

Remove os símbolos de formatação do CPF e retorna somente números. Filtra apenas os símbolos utilizados para a validação do CPF. Propositalmente não remove outros símbolos.

Remove formatting symbols from CPF and return only digits.
It only filters out the symbols used for CPF validation.
It purposefully doesn't remove other symbols.

```python
>>> from brutils import parse_cpf
Expand All @@ -66,7 +67,7 @@ Remove os símbolos de formatação do CPF e retorna somente números. Filtra ap
```
## generate_cpf

Gera um CPF válido aleatório.
Generate a valid random CPF.

```python
>>> from brutils import generate_cpf
Expand All @@ -76,7 +77,7 @@ Gera um CPF válido aleatório.

## is_valid_cnpj

Verifica se o CNPJ é valido. Apenas números, formatados como string.
Check if CNPJ is valid. Numbers only, formatted as strings.

```python
>>> from brutils import is_valid_cnpj
Expand All @@ -86,7 +87,7 @@ False

## format_cnpj

Formata o CNPJ.
Format CNPJ.

```python
>>> from brutils import format_cnpj
Expand All @@ -96,7 +97,9 @@ Formata o CNPJ.

## parse_cnpj

Remove os símbolos de formatação do CPF e retorna somente números. Filtra apenas os símbolos utilizados para a validação do CPF. Propositalmente não remove outros símbolos.
Remove formatting symbols from CNPJ and return only digits.
It only filters out the symbols used for CNPJ validation.
It purposefully doesn't remove other symbols.

```python
>>> from brutils import parse_cnpj
Expand All @@ -106,7 +109,7 @@ Remove os símbolos de formatação do CPF e retorna somente números. Filtra ap

## generate_cnpj

Gera um CNPJ válido aleatório.
Generate a valid random CNPJ.

```python
>>> from brutils import generate_cnpj
Expand Down

0 comments on commit f2ef2ef

Please sign in to comment.