marlysson/pycep

Um simples wrapper para api requisitar um endereço no endpoint do ViaCEP

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.

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

>>> 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..

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.

try:
	endereco = pycep.get("99999999")
except AddressNotFound:
	# Processamento para endereço inexistente

pycep's Issues

Validate when non string was used

Mock the requests and use fixtures tests

Add fixtures tests and simulate request to api viacep

Remove dependences

Remove dependence by requests..

Use urllib ( porting between py2 and py3)

Use setter property to encapsulate validation

@property
def value(self):
    return self._value

@value.setter
def value(self,value):
    # validation