Skip to main content

No project description provided

Project description

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

Requerimentos

Esse projeto é compatível com as versões 3.10 e 3.11 do python no momento. A compatibilização com versões anteriores está prevista, e qualquer contribuição é bem vinda.

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

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:

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

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 - Requisições HTTP
  • Poetry - Gerenciamento de dependências e publicação
  • Pytest - Testes automatizados

Autor

  • Erick Duarte - Implementação inicial - erickod

Licença

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

Menções importantes

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

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

pycep-1.0.1.tar.gz (6.5 kB view hashes)

Uploaded Source

Built Distribution

pycep-1.0.1-py3-none-any.whl (8.9 kB view hashes)

Uploaded Python 3

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page