Metadata-Version: 2.1
Name: pycep
Version: 1.0.1
Summary: 
Author: Erick Duarte
Author-email: erickod@gmail.com
Requires-Python: >=3.10,<3.12
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Requires-Dist: aiohttp (>=3.8.6,<4.0.0)
Requires-Dist: pytest-asyncio (>=0.21.1,<0.22.0)
Description-Content-Type: text/markdown

# PyCEP
Consulta CEPs em vários serviços (Correios, ViaCep, OpenCep) de maneira totalmente assíncrona

## Comece por aqui
Nesta seção você encontrará instruções de como instalar o pacote e também encontrará exemplos de uso
### Instalação

##### PIP
```
pip install pycep
```

##### Poetry
```
poetry add pycep
```

### Fazendo uma consulta
Tenha em mente que a lib vai retornar o serviço que responder mais rápido

```python
from pycep import Cep

cep = Cep("75140070")
```

### Acessando os dados da consulta
Você pode usar os atributos listados abaixo para acessar os dados do Cep:

```python
from pycep import Cep

cep = Cep("75140070")

print(cep.number) # 75140070
print(cep.state) # GO
print(cep.city) # Anápolis
print(cep.street) # Rua Senador Mardocheu Diniz
print(cep.district) # Dom Pedro II
print(cep.query_service) #CorreiosService
print(cep.status) # query_done
```

Você também pode converter os dados para dict

```python
from pycep import Cep

cep = Cep("75140070")
print(dict(cep))

{
 'street': 'Rua Senador Mardocheu Diniz', 
 'district': 'Dom Pedro II', 
 'city': 'Anápolis', 
 'state': 'GO', 
 'cep': '75140070', 
 'provider': 'CorreiosService'
 }

```


## Este projeto utiliza

* [AioHTTP](https://docs.aiohttp.org/en/stable/) - Requisições HTTP
* [Poetry](https://python-poetry.org/) - Gerenciamento de dependências e publicação
* [Pytest](https://docs.pytest.org/) - Testes automatizados

## Autor

* **Erick Duarte** - *Implementação inicial* - [erickod](https://github.com/erickod)

## Licença

O projeto está disponível através da licença MIT - Consulte o arquivo [LICENSE.md](LICENSE.md) para mais detalhes.

## Menções importantes

* Este projeto foi inspirado na lib `cep-promise`, criada pelo Felipe Deschamps.
