https://github.com/marlysson/pycep
Um simples wrapper para api requisitar um endereço no endpoint do ViaCEP
https://github.com/marlysson/pycep
cep-search viacep
Last synced: 2 months ago
JSON representation
Um simples wrapper para api requisitar um endereço no endpoint do ViaCEP
- Host: GitHub
- URL: https://github.com/marlysson/pycep
- Owner: Marlysson
- Created: 2016-11-28T14:05:28.000Z (over 8 years ago)
- Default Branch: master
- Last Pushed: 2016-12-03T21:32:55.000Z (over 8 years ago)
- Last Synced: 2025-01-29T03:28:40.447Z (4 months ago)
- Topics: cep-search, viacep
- Language: Python
- Homepage:
- Size: 7.81 KB
- Stars: 1
- Watchers: 2
- Forks: 0
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Pycep
Um wrapper para a api da ViaCEP para consulta dos endereços dos ceps do Brasil.
Depois de requisitar o endereço de um cep você pode tratar o retorno como se fosse um objeto normal , inclusive já feito o cast para o valor adequado.
### Requisitos
> Temporário ( futuramente não será necessário dependências )
- requests
## Como usar
Primeiramente rode o arquivo de requisitos do projeto.
```bash
pip install -r requirements.txt
```
Com as dependências instaladas você pode começar a requisitar os endereços.
> **Dados retornados:** cep, logradouro, complemento, bairro, localidade, uf, unidade, ibge, gia
```python
>>> from pycep import Pycep as pycep
>>> endereco = pycep.get("01001-000")
>>> endereco.localidade
São Paulo
>>> endereco.ibge
3550308
>>> endereco2 = pycep.get("01001000")
>>> endereco2.localidade
São Paulo
```
### Tratando erros:
Em qualquer caso de erro é levantada a exceção ```InvalidCepException``` , seja se o cep tiver strings , não contiver 8 caracteres..
```python
try:
endereco = pycep.get("123456789")
except InvalidCepException:
# Processamento em caso de erro
```
### Caso para o endereço não encontrado:
Quando um endereço não é encontrado é levantada a exceção ```AddressNotFound``` que você pode capturar ela e tratar como quiser.
```python
try:
endereco = pycep.get("99999999")
except AddressNotFound:
# Processamento para endereço inexistente
```