Skip to main content

API para busca de CEP no webservice dos Correios

Project description

PyCEPCorreios

https://img.shields.io/travis/mstuttgart/pycep-correios/develop.svg?style=flat-square https://img.shields.io/coveralls/mstuttgart/pycep-correios/develop.svg?style=flat-square https://landscape.io/github/mstuttgart/pycep-correios/develop/landscape.svg?style=flat-square https://img.shields.io/pypi/v/pycep-correios.svg?style=flat-square https://img.shields.io/pypi/pyversions/pycep-correios.svg?style=flat-square https://img.shields.io/pypi/l/pycep-correios.svg?style=flat-square

API para consulta de CEP diretamente do webservice dos Correios.

Features

  • Consulta de dados do endereço de um CEP

  • Formatacao de CEP

  • Validação de estrutura do CEP

Documentação

Para mais detalhes sobre a PyCEPCorreios, por gentileza, consulte a documentação oficial (também disponível em Inglẽs):

Instalação

O PyCEP Correios pode ser facilmente instalado com o comando a seguir:

pip install pycep-correios

Atualmente, a PyCEPCorreios possui suporte para Python 3.4+.

Como usar

Consultar o endereço de um CEP é muito simples com o PyCEPCorreios. Veja os exemplos a seguir:

>>> import pycep_correios

>>> endereco = pycep_correios.consultar_cep('37503130')
>>> print(endereco)
{
    'bairro': 'Santo Antônio',
    'cep': '37503130',
    'cidade': 'Itajubá',
    'end': 'Rua Geraldino Campista',
    'id': '0',
    'uf': 'MG',
    'complemento': '',
    'complemento2': '- até 214/215',
}

ou

import pycep_correios

endereco = pycep_correios.consultar_cep('37503130')
print(endereco.end)
print(endereco.bairro)
print(endereco.cidade)
print(endereco.complemento)
print(endereco.complemento2)
print(endereco.uf)
print(endereco.cep)

Aviso de bugs, dúvidas e sugestões

Para dúvidas, sugestões e relatórios de bugs, por gentileza, crie uma issue:

Como contribuir

Deseja participar do desenvolvimento da PyCepCorreios? Torne-se um contribuidor do PyCEPCorreios! visite a documentação para verificar a guideline de contribuição:

Contribuidores

Agradecimentos aos seguintes contribuidores pelo esforço de fazer a PyCEPCorreios melhor:

Créditos

Copyright (C) 2016-2018 por Michell Stuttgart Faria

Histórico

3.0.0 (2018-10-21)

  • Alteração da API de consulta para [python-zeep](https://pypi.org/project/zeep/)

  • Antigas exceptions agora estão deprecated. Usar apenas ExcecaoPyCEPCorreios

  • Atualização da documentação

  • Remoção do suporte para Python 2.7

2.3.1 (2018-05-03)

  • Corrige README.rst

  • Adiciona comando para validação dpo setup.py no Makefile

  • Corrige link do repositorio e donwload

2.3.0 (2018-05-03)

  • Adiciona logging para consulta de CEP

  • Adiciona documentação em inglês

  • Versão requirida das libs requests e da Jinja2 limitadas por baixo, para fins de compatibilidade

  • Remove suporte para Python 3.3

2.2.0 (2017-07-16)

2.1.1 (2017-06-30)

  • Correção de erros de unicode com python2.7

2.1.0 (2017-06-29)

  • Adicionado suporte para Python 2.7+

  • Ajustes e correções na documentação

2.0.0 (2017-06-20)

  • Atualização do código da PyCEPCorreios, deixando-a mais facil de ser utilizada

  • Remoção das exceções antigas, deixando apenas a Exceção padrão da lib

  • Remoção da classe PyCEPCorreios

  • Alteração dos imports da lib para facilitar seu uso e diminuir tamanho dos imports

  • Adicionado documentação com Sphinx

  • Adicionado testes com TOX

  • Adicionado método de validação de CEP e formatação de CEP

1.1.7 (2017-05-09)

  • Corrigido erro jinja2.exceptions.TemplateNotFound: consultacep.xml

  • Erro durante instalação da PyCEPCorreios via pip

  • Atualizado código de exemplo no README.rst

  • Atualizado exemplos na documentação

1.1.6 (2017-05-08)

  • Correção de bug durante instalação. #15

  • Correção de template xml ausente no pacote do modulo

  • Melhorias gerais no código e correções de bugs

1.1.1 (2017-02-08)

  • Melhorias gerais no código

  • XML schema utilizando Jinja2

1.0.1 (2016-08-03)

  • Simplificação da classes Exceptions

  • Organização do código de teste

  • Utilização do mock para test

1.0.0 (2016-07-31)

  • API migrada para Python 3. Python 2.7 não será mais suportado

  • Substituição da lib suds pela lib requests para realizar as requisições

0.0.2 (2016-05-09)

  • setup.py com número de versão atualizado e dependência corrigidas.

0.0.1 (2016-05-05)

  • Versão inicial.

  • Permite busca no webservice dos correios dos dados de um CEP fornecido.

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_correios-3.0.1.tar.gz (52.4 kB view hashes)

Uploaded Source

Built Distribution

pycep_correios-3.0.1-py2.py3-none-any.whl (7.6 kB view hashes)

Uploaded Python 2 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