mstuttgart/brazilcep

About | Install | How to Use | Documentation Contribute Credits

About

BrazilCEP is a minimalist and easy-to-use python library designed to query CEP (brazilian zip codes) data.

Its objective is to provide a common query interface to all these search services, facilitating the integration of Python applications with these services.

Currently supports several CEP API's:

• ViaCEP
• ApiCEP (WideNet)
• Correios (SIGEPWeb)

BrazilCEP is the new name of former PyCEPCorreio python library. If you want to migrate the old code to the new version, please see the migrate section in docs.

Install

The recommended way to get BrazilCEP is to install the latest stable release via pip:

pip install brazilcep

We currently support Python 3.8+ only. Users on older interpreter versions are urged to upgrade.

How to Use

Making a request is very simple. Begin by importing the BrazilCEP module:

>>> import brazilcep

Now, call the get_address_from_cep to query any CEP:

>>> address = brazilcep.get_address_from_cep('37503-130')

Now, we have a dict object called address. We can get all the address information we need from this object:

 >>> address
{
    'district': 'rua abc',
    'cep': '37503130',
    'city': 'city ABC',
    'street': 'str',
    'uf': 'str',
    'complement': 'str',
}

The CEP always must be a string.

Documentation

Documentation for the current version of BrazilCEP is available from the official docs here.

Contribute

See this guideline here.

Credits

Copyright (C) 2016-2023 by Michell Stuttgart